API Reference
Reference for the Ready Player Me Unreal SDK

Dependencies

Dependencies are already included in the .uplugin file.

Class Reference

ReadyPlayerMeActor

ReadyPlayerMeActor class is intended to be used as an actor for runtime loading and displaying the avatars.

Public Properties

USkeletalMeshComponent* SkeletalMeshComponent
  • The default SkeletalMeshComponent. The skeletal mesh will be set during the avatar loading process
UReadyPlayerMeActorComponent* ReadyPlayerMeComponent
  • Handles the loading and setup of the avatar.

ReadyPlayerMeComponent

ReadyPlayerMeComponent is an actor component that is responsible for the loading of the avatar and visualizing it by setting the SkeletalMesh of the avatar. It also provides useful functions for loading the avatar and loading a rendered image of the avatar. ReadyPlayerMeComponent internally uses ReadyPlayerMeAvatarLoader for loading the avatar and ReadyPlayerMeRenderLoader for rendering the avatar.
The actor containing this component needs to also contain a SkeletalMeshComponent.

Public Properties

FString UrlShortcode
  • The avatar url or shortcode. It's used to load the avatar from the web.
USkeleton* TargetSkeleton
  • The skeleton that will be used for the loaded avatar. If it's not set, the default skeleton will be used for the loaded avatar.
FAvatarMetadata AvatarMetadata
  • provides read-only information about the loaded avatar. Such as the type of the avatar, outfit, and gender.

Public Functions

void LoadAvatar(const FAvatarLoadFailed& OnLoadFailed);
  • Downloads the avatar from the web and generates a skeletal mesh of the avatar. If the model was previously downloaded and stored locally, the local model will be used for the loading of the avatar if avatar caching is enabled.
void LoadNewAvatar(const FString& Url, const FAvatarLoadFailed& OnLoadFailed);
  • Downloads the avatar from the web using the provided url and generates a skeletal mesh of the avatar. If the model was previously downloaded and stored locally, the local model will be used for the loading of the avatar if caching is enabled.
void LoadRender(const ERenderSceneType& SceneType, const FDownloadImageCompleted& OnCompleted, const FDage for townloadImageFailed& OnFailed);
  • Loads the rendered image of the avatar from the server. By setting the SceneType the avatar can be rendered in different scenes.

ReadyPlayerMeAvatarLoader

It's responsible for Loading the avatar from the url and storing it in the local storage. ReadyPlayerMeAvatarLoader is used by ReadyPlayerMeActorComponent for loading the avatar.

Public Functions

void LoadAvatar(const FString& Url, const FAvatarLoadCompleted& OnLoadCompleted, const FAvatarLoadFailed& OnLoadFailed, bool bShouldLoadMetadata = true);
  • Downloads the avatar asset from the Url and saves it in the local storage.

ReadyPlayerMeRenderLoader

It's responsible for Loading the rendered image from the ModelUrl. ReadyPlayerMeRenderLoader is used by ReadyPlayerMeActorComponent but It can also be used independently.

Public Functions

void Load(const FString& ModelUrl, const ERenderSceneType& SceneType, const EAvatarGender& Gender, const FDownloadImageCompleted& OnCompleted, const FDownloadImageFailed& OnFailed);
  • Loads the rendered image.

ReadyPlayerMeBlueprintLibrary

It's responsible for providing public functions that can be called directly from Blueprints.
Public Functions
static void ClearAvatarCache();
  • deletes all avatars currently stored locally
Copy link
On this page
Dependencies
Class Reference
ReadyPlayerMeActor
ReadyPlayerMeComponent
ReadyPlayerMeAvatarLoader
ReadyPlayerMeRenderLoader
ReadyPlayerMeBlueprintLibrary