EasyTalk API
Loading...
Searching...
No Matches
EasyTalk.Nodes.Utility.ShowNodeItem Class Reference

Defines the structure of an item within a Show node for showing a Dialogue Panel or a character portrayal. More...

Inherits EasyTalk.Nodes.Core.ListItem.

Public Member Functions

 ShowNodeItem ()
 Creates a new ShowNodeItem.
 
 ShowNodeItem (ShowMode showMode, string characterName, string imageId, bool overrideDisplayId, string displayId)
 Creates a new ShowNodeItem.
 
- Public Member Functions inherited from EasyTalk.Nodes.Core.ListItem
 ListItem ()
 

Properties

string CharacterName [get, set]
 Gets or sets the ID of the character's portrayal to show.
 
ShowMode ShowMode [get, set]
 Gets or sets the mode to use.
 
string ImageID [get, set]
 Gets or sets the character portrayal image to use.
 
bool OverrideDisplayID [get, set]
 Gets or sets whether the display ID to use for character portrayals should override the default target ID configured in the character library.
 
string DisplayID [get, set]
 Gets or sets the Display ID to show.
 
bool IsExpanded [get, set]
 Gets or sets whether the item is in an expanded state in the node editor UI.
 

Private Attributes

ShowMode mode
 The mode to use, either DISPLAY or CHARACTER.
 
string characterName
 The name of the character to show (if applicable).
 
string imageId
 The ID of the character's portrayal to show (if applicable).
 
bool overrideDisplayId
 Whether or not the display ID should be overridden for showing a character portrayal (if applicable).
 
string displayId
 The Display ID of the display to show (if applicable).
 
bool isExpanded
 Whether or not the item is expanded in the node (used for editor UI).
 

Detailed Description

Defines the structure of an item within a Show node for showing a Dialogue Panel or a character portrayal.

Constructor & Destructor Documentation

◆ ShowNodeItem() [1/2]

EasyTalk.Nodes.Utility.ShowNodeItem.ShowNodeItem ( )

Creates a new ShowNodeItem.

◆ ShowNodeItem() [2/2]

EasyTalk.Nodes.Utility.ShowNodeItem.ShowNodeItem ( ShowMode showMode,
string characterName,
string imageId,
bool overrideDisplayId,
string displayId )

Creates a new ShowNodeItem.

Parameters
showModeThe ShowMode to use.
characterNameThe name of the character to show.
imageIdThe ID of the character portrayal to show.
overrideDisplayIdWhether the display ID is overridden.
displayIdThe Display ID of the display to show.

Member Data Documentation

◆ characterName

string EasyTalk.Nodes.Utility.ShowNodeItem.characterName
private

The name of the character to show (if applicable).

◆ displayId

string EasyTalk.Nodes.Utility.ShowNodeItem.displayId
private

The Display ID of the display to show (if applicable).

◆ imageId

string EasyTalk.Nodes.Utility.ShowNodeItem.imageId
private

The ID of the character's portrayal to show (if applicable).

◆ isExpanded

bool EasyTalk.Nodes.Utility.ShowNodeItem.isExpanded
private

Whether or not the item is expanded in the node (used for editor UI).

◆ mode

ShowMode EasyTalk.Nodes.Utility.ShowNodeItem.mode
private

The mode to use, either DISPLAY or CHARACTER.

◆ overrideDisplayId

bool EasyTalk.Nodes.Utility.ShowNodeItem.overrideDisplayId
private

Whether or not the display ID should be overridden for showing a character portrayal (if applicable).

Property Documentation

◆ CharacterName

string EasyTalk.Nodes.Utility.ShowNodeItem.CharacterName
getset

Gets or sets the ID of the character's portrayal to show.

◆ DisplayID

string EasyTalk.Nodes.Utility.ShowNodeItem.DisplayID
getset

Gets or sets the Display ID to show.

◆ ImageID

string EasyTalk.Nodes.Utility.ShowNodeItem.ImageID
getset

Gets or sets the character portrayal image to use.

◆ IsExpanded

bool EasyTalk.Nodes.Utility.ShowNodeItem.IsExpanded
getset

Gets or sets whether the item is in an expanded state in the node editor UI.

◆ OverrideDisplayID

bool EasyTalk.Nodes.Utility.ShowNodeItem.OverrideDisplayID
getset

Gets or sets whether the display ID to use for character portrayals should override the default target ID configured in the character library.

◆ ShowMode

ShowMode EasyTalk.Nodes.Utility.ShowNodeItem.ShowMode
getset

Gets or sets the mode to use.