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

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

Inherits EasyTalk.Nodes.Core.ListItem.

Public Member Functions

 HideNodeItem ()
 Creates a new HideNodeItem.
 
 HideNodeItem (HideMode hideMode, string characterName, string displayId)
 Creates a new HideNodeItem.
 
- Public Member Functions inherited from EasyTalk.Nodes.Core.ListItem
 ListItem ()
 

Properties

string CharacterName [get, set]
 Gets or sets the name of the character to hide.
 
HideMode HideMode [get, set]
 Gets or sets the HideMode.
 
string DisplayID [get, set]
 Gets or sets the Display ID of the display (Dialogue Panel) to hide.
 
bool IsExpanded [get, set]
 Gets or sets whether the item is in an expanded state in the node editor UI.
 

Private Attributes

HideMode mode
 The mode to use, either DISPLAY or CHARACTER.
 
string characterName
 The name of the character to hide (if applicable).
 
string displayId
 The Display ID of the display to hide (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 Hide node for showing a Dialogue Panel or a character portrayal.

Constructor & Destructor Documentation

◆ HideNodeItem() [1/2]

EasyTalk.Nodes.Utility.HideNodeItem.HideNodeItem ( )

Creates a new HideNodeItem.

◆ HideNodeItem() [2/2]

EasyTalk.Nodes.Utility.HideNodeItem.HideNodeItem ( HideMode hideMode,
string characterName,
string displayId )

Creates a new HideNodeItem.

Parameters
hideModeThe HideMode to use.
characterNameThe name of the character to hide.
displayIdThe name of the display (DIalogue Panel) to hide.

Member Data Documentation

◆ characterName

string EasyTalk.Nodes.Utility.HideNodeItem.characterName
private

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

◆ displayId

string EasyTalk.Nodes.Utility.HideNodeItem.displayId
private

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

◆ isExpanded

bool EasyTalk.Nodes.Utility.HideNodeItem.isExpanded
private

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

◆ mode

HideMode EasyTalk.Nodes.Utility.HideNodeItem.mode
private

The mode to use, either DISPLAY or CHARACTER.

Property Documentation

◆ CharacterName

string EasyTalk.Nodes.Utility.HideNodeItem.CharacterName
getset

Gets or sets the name of the character to hide.

◆ DisplayID

string EasyTalk.Nodes.Utility.HideNodeItem.DisplayID
getset

Gets or sets the Display ID of the display (Dialogue Panel) to hide.

◆ HideMode

HideMode EasyTalk.Nodes.Utility.HideNodeItem.HideMode
getset

Gets or sets the HideMode.

◆ IsExpanded

bool EasyTalk.Nodes.Utility.HideNodeItem.IsExpanded
getset

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