InworldUserSetting
In Module: Inworld.AI
By default, we provide a non-editable InworldUserSetting scriptable object called UserSettings as a template for user data. When using Inworld's Unity Editor extension, it generates an editable InworldUserSetting scriptable object named after the Inworld username for each Inworld user.
The InworldUserSetting will be updated to the most recent version in the InworldAI scriptable object, or it will default to the initial settings if no data is available.
Inspector Variables
| Variable | Description |
|---|---|
| Player Name | The displayed username, which is also used in the runtime. It is generated by default using the Unity account name. |
| Player Data | This user's PlayerProfiles, also used in the runtime when entering Inworld scenes. |
| Workspaces | This user's workspaces, which will be fetched once logged in Inworld Studio Panel. |
Properties
| Property | Description |
|---|---|
| Name | Get/Set the player name, which will be displayed in the game. If you want to change the name at runtime, you need to send a unitary request. |
| Request | Get the User request used for loading scenes. |
| Setting | Get the User setting (Player profile in Inworld Studio). |
| PlayerProfiles | Get the list of PlayerProfiles |
| BillingAccount | Get the user's billing account. It's generated via Inworld Studio Panel. Please do not modify it; otherwise, Inworld interactions may not work. |
| Account | Get the account ID sent to Inworld's data analysis server. |
| ID | Get the user ID. It's generated via Inworld Studio Panel. Please do not modify it; otherwise, Inworld interactions will not work. |
| Workspace | Get the list of InworldWorkspaceData. |
| WorkspaceList | Get the list of workspaces by their full names. |
API
| Function | Description | Parameters |
|---|---|---|
| GetWorkspaceFullName | Get the workspace full name by its display name. | displayName: the display name of the target workspace. |
| GetWorkspaceByDisplayName | Get the InworldWorkspaceData by its display name. | displayName: the display name of the target workspace. |
| GetSceneByFullName | Get the InworldWorkspaceData by its display name | sceneFullName: the display name of the target scene. |