InworldSceneData

This file stores the data in the response for loading scenes, including scene name, scene descriptions, and character info in this Inworld scene.

Classes

InworldSceneData

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
name	The unique full name of the Inworld scene.
displayName	The display name of the Inworld scene.
description	The description of the Inworld scene.
characterReferences	A list of CharacterReference that belongs to the Inworld scene.

Properties	Description
Progress	The current data fetching process of the Inworld scene in general.

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.

ListSceneResponse

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
scenes	The list of the InworldSceneData.
nextPageToken	If there are too many InworldSceneData, this token is used for generating the next page of ListSceneResponse.

LoadSceneRequest

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
name	The unique full name of the Inworld scene.

LoadCharactersRequest

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
name	The brain name of the InworldCharacter.

LoadSceneEvent

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
loadScene	The LoadSceneRequest to send to Inworld server.

LoadCharactersEvent

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
loadCharacters	The LoadCharactersRequest to send to Inworld server.

LoadScenePacket

Module: Inworld.AI. Namespace: Inworld.Entities. Inherited from InworldPacket

Variables	Description
mutation	The LoadSceneEvent to send to Inworld server.

LoadCharactersPacket

Module: Inworld.AI. Namespace: Inworld.Entities. Inherited from InworldPacket

Variables	Description
mutation	The LoadCharactersEvent to send to Inworld server.

LoadSceneResponse

Module: Inworld.AI. Namespace: Inworld.Entities.

Variables	Description
agents	The list of the InworldCharacterData that within the scene.

Function	Description	Parameters
UpdateRegisteredCharacter	Returns the list of the InworldCharacterData if any of them is in the current live session.	outData: the reference of the list of the InworldCharacterData.