Skip to main content

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.

UserSetting

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.

UserSetting2

Inspector Variables

VariableDescription
Player NameThe displayed username, which is also used in the runtime. It is generated by default using the Unity account name.
Player DataThis user's PlayerProfiles, also used in the runtime when entering Inworld scenes.
WorkspacesThis user's workspaces, which will be fetched once logged in Inworld Studio Panel.

Properties

PropertyDescription
NameGet/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.
RequestGet the User request used for loading scenes.
SettingGet the User setting (Player profile in Inworld Studio).
PlayerProfilesGet the list of PlayerProfiles
BillingAccountGet the user's billing account. It's generated via Inworld Studio Panel. Please do not modify it; otherwise, Inworld interactions may not work.
AccountGet the account ID sent to Inworld's data analysis server.
IDGet the user ID. It's generated via Inworld Studio Panel. Please do not modify it; otherwise, Inworld interactions will not work.
WorkspaceGet the list of InworldWorkspaceData.
WorkspaceListGet the list of workspaces by their full names.

API

FunctionDescriptionParameters
GetWorkspaceFullNameGet the workspace full name by its display name.displayName: the display name of the target workspace.
GetWorkspaceByDisplayNameGet the InworldWorkspaceData by its display name.displayName: the display name of the target workspace.
GetSceneByFullNameGet the InworldWorkspaceData by its display namesceneFullName: the display name of the target scene.