Skip to main content

InworldEditor

Properties

PropertyTypeDescription
InstanceInworldEditorGets an instance of the InworldEditor. It will create an Inworld Studio Panel if the panel has not opened
ProgressDictionary<InworldWorkspaceData, WorkspaceFetchingProgress>Gets the current data fetching progress across all the workspaces
StatusInworldEditorStatusGets or sets the current Inworld Editor Status. The old status will call OnExit() and the new status will call OnEnter()
CurrentProgressInworldUISettingsGets the current workspace's data fetching progress
IsDataValidboolChecks if all the data in the current data of the Inworld Game Setting is true

API

FunctionReturn TypeDescriptionParameters
ShowPanelvoidOpens the Inworld Studio Panel. This will detect and pop the import window if you do not have TMP importedN/A
SetupInworldCharactervoidSets a gameObject in the scene with InworldCharacterData. If the InworldCharacterData belongs to an InworldAI.Game.CurrentScene, then the data and its related components (e.g., animation, player detecting, etc.) will be added to the gameObject. All the characters that have associated Inworld Character Data but that are not in the current Inworld Scene will be deletedavatar: That gameObject that you want to bind an InworldCharacter to. selectedCharacter: The InworldCharacterData to add to the gameObject. Note that the InworldCharacterData should be in InworldAI.Game.CurrentScene
LoadPlayerControllervoidAdds a player controller into the current scene. Note that: 1. Player controller is mandatory for the characters to communicate. 2. If you call this function, then the main camera in your current scene will be deleted. If you have your own player control that allows characters to communicate, then add InworldController.Player to your customized controller objectN/A