InworldUIElement

Module: Inworld.AI. Namespace: Inworld.UI.

This is the base class used in rendering UI element in the runtime.

Variables

Variables	Description
Icon	the icon used in the UI element.
Title	the title text in the UI element.

Properties

Properties	Description
Height	Gets the bubble's height.
Icon	Get/Set the Thumbnail of the bubble. NOTE: For the worldspace's floating text, Icon will not be displayed.
Title	Gets/Sets the name of the thumbnail.

API

Functions	Description	Parameters
SetBubble	Set the bubble's property.	charName: The bubble's owner's name. thumbnail: The bubble's owner's thumbnail. text:The bubble's content
SetBubbleWithPacketInfo	Set the bubble's property by InworldPacket	charName:The bubble's owner's name interactionID:The bubble's interaction ID correlationID: The bubble's correlation ID thumbnailThe bubble's owner's thumbnail. text: The bubble's content.
AttachBubble	Attach text to the current bubble.	text: the text to add.

Related Classes

CharacterButton

Module: Inworld.AI. Namespace: Inworld.UI. Inherited from InworldUIElement.

Variables	Description
Data	The InworldCharacterData displays in the button.
Char	The InworldCharacter displays in the button.

Functions	Description	Parameters
SetData	Set the character's data.	data: The InworldCharacterData to set.
SelectCharacter	Select this character to interact with.
GetCharacter	Get this character displayed in the button.

ChatBubble

Module: Inworld.AI. Namespace: Inworld.UI. Inherited from InworldUIElement, IPointerUpHandler, IPointerDownHandler.

Variables	Description
TextField	The content text in the bubble.

Properties	Description
Text	Get/Set the bubble's main content.

Functions	Description	Parameters
SetBubble	Set the bubble's property.	charName: The bubble's owner's name. thumbnail: The bubble's owner's thumbnail. text:The bubble's content
SetBubbleWithPacketInfo	Set the bubble's property by InworldPacket	charName:The bubble's owner's name interactionID:The bubble's interaction ID correlationID: The bubble's correlation ID thumbnailThe bubble's owner's thumbnail. text: The bubble's content.
AttachBubble	Attach text to the current bubble.	text: the text to add.
OnPointerDown	Triggers when mouse is clicked down.	eventData: the PointerEventData got in the Unity engine.
OnPointerUp	Triggers when mouse is clicked up.	eventData: the PointerEventData got in the Unity engine.

ConnectButton

Module: Inworld.AI. Namespace: Inworld.UI.

Variables	Description
Status	The text component for displaying InworldConnectionStatus.
ConnectButton	The connect button.
ButtonText	The text on the button.

Functions	Description	Parameters
ConnectInworld	Manages the InworldController connection with the Inworld server

RecordButton

Module: Inworld.AI. Namespace: Inworld.UI. Inherited from MonoBehavior, IPointerUpHandler, IPointerDownHandler.

Functions	Description	Parameters
OnPointerDown	Triggers when this button is hold down.	eventData: The PointerEventData from Unity.
OnPointerUp	Triggers when this button is released.	eventData: The PointerEventData from Unity.