InworldCharacterData
This file contains data for an Inworld character received from the Inworld server. It includes the agent ID, thumbnail, and other assets.
Classes
InworldCharacterData
Module: Inworld.AI.
Namespace: Inworld.Entities.
| Variables | Description |
|---|
| agentId | The live session ID of the character. It's generated after LoadScene is completed, and it changes each time this variable is updated. |
| brainName | The unique full name of the character in the format, workspace/xxx/characters/yyy |
| givenName | The character's display name, such as John |
| characterAssets | The CharacterAssets associated with the character. |
| thumbnail | The character's thumbnail image. |
| Properties | Description |
|---|
| CharacterFileName | Get the file name stored in the Assets folder, formatted as {BrainName}_{WorkspaceName} |
| Functions | Description | Parameters |
|---|
| UpdateThumbnail | Used to update thumbnail of that character in the runtime. | |
CharacterName
Module: Inworld.AI.
Namespace: Inworld.Entities.
| Variables | Description |
|---|
| name | The brain name of the InworldCharacter. |
| languageCode | The language the InworldCharacter is using. Used for multiple language support in the future. |
CharacterAssets
Module: Inworld.AI.
Namespace: Inworld.Entities.
| Variables | Description |
|---|
| rpmModelUri | The model URI for the Ready Player Me avatar. Nullable. |
| rpmImageUriPortrait | The portrait image URI for the Ready Player Me avatar. Nullable. |
| rpmImageUriPosture | The posture image URI for the Ready Player Me avatar. Nullable. |
| avatarImg | The character's avatar image. Nullable. |
| avatarImgOriginal | The reference to the original avatar image, in case it's changed. Nullable. |
| thumbnailProgress | The download progress of the ThumbnailURL. |
| avatarProgress | The download progress of the rpmModelUri. |
| Properties | Description |
|---|
| Progress | The current data fetching progress of the character in general. |
| ThumbnailURL | The URL for the default thumbnail image. |
| Functions | Description | Parameters |
|---|
| IsAsset | Determine whether the target URL is one of the character's asset links. | url: the target url. |
| CopyFrom | Copy the data of CharacterAssets from another instance. | rhs: the CharacterAssets to copy. |
CharacterDescription
Module: Inworld.AI.
Namespace: Inworld.Entities.
| Variables | Description |
|---|
| givenName | The display name of the character, such as John. |
| description | The description of the character. |
CharacterOverLoad
Module: Inworld.AI.
Namespace: Inworld.Entities.
CharacterReference
Module: Inworld.AI.
Namespace: Inworld.Entities.
| Variables | Description |
|---|
| character | The agentID of the character. |
| characterOverloads | The list of the CharacterOverLoad. (Currently, only one element is supported, but we may add support for multiple character descriptions later.) |
| Properties | Description |
|---|
| Progress | The current data fetching process of the character in general. |
| CharacterFileName | Get the file name stored in Assets folder. Format as {BrainName}_{WorkspaceName} |