Inworld Character Data
InworldCharacterData contains the the data for an InworldCharacter. It can be created locally, but it is mostly loaded and updated from the server. Note that,
- The Inworld Studio Server can update everything except the ID
- The Inworld Run-Time Server can update the ID
⚠️ Note: The file containing InworldCharacterData is stored locally via CharacterName. The CharacterName field is not unique when retrieving data from the server. Please ensure that the CharacterName is set uniquely to prevent any possible data collisions.
Public Variables
| Public Variable | Description |
|---|---|
| Character Name | The display name |
| Brain | The MR Code |
| Thumbnail | The sprite, which, by default, is generated by Preview Image URI |
| Avatar | The .glb model |
| Workspace | The Inworld Workspace that a character is in |
| Current Scene | The current InworldScene that a character is in. This data will be refreshed at run-time |
| Owner Ship | The enum to distinguish detailed characters from characters that are fetched from the server |
| Triggers | The list of triggers that you set in the studio |
| Scenes | The list of scenes that the InworldCharacter is in |
| Model Uri | The URI of the .glb model from the Ready Player Me avatar |
| PosUri | The URI of the pose picture |
| Preview Image Uri | The URI of the thumbnail |
Properties
| Property | Type | Description |
|---|---|---|
| LocalThumbnailFileName | string | Gets the character's local thumbnail file name |
| LocalAvatarFileName | string | Gets the character's local avatar file name |
| Thumbnail | Texture2D | Gets the character's thumbnail. If it contains data, then that data is returned directly. If it contains previewImgUri, then that is downloaded and loaded. Otherwise, this will return the default thumbnail |
| Avatar | gameObject | Gets the character's avatar in .glb format. If it has data, then that data is returned directly. If it contains ModelUri, then that is downloaded and loaded it. Otherwise, this will return the default avatar |
| Progress | float | Returns the data fetching progress for the character. |
API
| Function | Return Type | Description | Parameters |
|---|---|---|---|
| CopyFrom | void | Copies the data from another InworldCharacter with the same characterName. | rhs: The reference for which InworldCharacterData to copy |