ReadyPlayerMeMemoryCache

Memory cache for preloading and reusing the avatars.

ReadyPlayerMeMemoryCache is used to preload avatars and store the cached skeletal meshes. Cached avatars will be instantiated instantly. It's mainly used for preloading the avatars in the background.
Properties
Property
Type
Description
CachedAvatars
TArray<FAvatarMemoryCacheData>
The avatar URL or shortcode used to load the avatar from the web.
Public Functions
Function
Returns
Text
Preload(const TArray& PreloadDataList, const FAvatarPreloadCompleted& OnPreloadCompleted)
void
Preloads the avatar data so the avatars would be instantiated instantly when loading them from the ReadyPlayerMeComponent.
GetAvatarCacheData(const FString& Url, UReadyPlayerMeAvatarConfig* AvatarConfig) const
FAvatarMemoryCacheData 
Returns the preload avatar data for a specific avatar.
AddAvatar(const FString& Url, UReadyPlayerMeAvatarConfig* AvatarConfig, USkeletalMesh* SkeletalMesh, const FAvatarMetadata& Metadata)
void
Adds an already loaded avatar to the memory cache.
RemoveAvatar(const FString& Url)
void
Removes specific avatar data from the memory cache.
RemoveAvatar()
void
Clears all avatars from the memory cache.
​
​

Property	Type	Description
CachedAvatars	TArray<FAvatarMemoryCacheData>	The avatar URL or shortcode used to load the avatar from the web.

Function	Returns	Text
`Preload(const TArray& PreloadDataList, const FAvatarPreloadCompleted& OnPreloadCompleted)`	void	Preloads the avatar data so the avatars would be instantiated instantly when loading them from the ReadyPlayerMeComponent.
`GetAvatarCacheData(const FString& Url, UReadyPlayerMeAvatarConfig* AvatarConfig) const`	FAvatarMemoryCacheData	Returns the preload avatar data for a specific avatar.
`AddAvatar(const FString& Url, UReadyPlayerMeAvatarConfig* AvatarConfig, USkeletalMesh* SkeletalMesh, const FAvatarMetadata& Metadata)`	void	Adds an already loaded avatar to the memory cache.
`RemoveAvatar(const FString& Url)`	void	Removes specific avatar data from the memory cache.
`RemoveAvatar()`	void	Clears all avatars from the memory cache.

ReadyPlayerMeComponent

ReadyPlayerMeSettings

Last modified 1mo ago