EasyTalk API
Loading...
Searching...
No Matches
EasyTalk.Display.DisplayUtils Class Reference

This is a utilty class for handling specific display functions, such as show/hide node functionality. More...

Static Public Member Functions

static void HandleShowNode (AsyncNode node, Dictionary< string, DialoguePanel > displayMap, EasyTalkDialogueSettings dialogueSettings)
 Processes ths provided Show node, showing each panel/character configured for the node.
 
static void HandleHideNode (AsyncNode node, Dictionary< string, DialoguePanel > displayMap, EasyTalkDialogueSettings dialogueSettings)
 Processes the provided Hide node, hiding each panel/character configured for the node.
 

Static Private Member Functions

static void PanelShown ()
 Called when a panel has finished being shown. After the target counter is reached, ExecutionCompleted() is called on the active Show node.
 
static void PanelHidden ()
 Called when a panel has finished being hidden. After the target counter is reached, ExecutionCompleted() is called on the active Hide node.
 

Static Private Attributes

static AsyncNode activeNode
 The currently active node.
 
static List< DialoguePanelpanelsToShow = new List<DialoguePanel>()
 A List of panels which are to be shown.
 
static int numPanelsShown = 0
 The number of panels shown.
 
static int numPanelsToShow = 0
 The target number of panels to show.
 
static List< DialoguePanelpanelsToHide = new List<DialoguePanel>()
 A List of panels which are to be hidden.
 
static int numPanelsHidden = 0
 The number of panels hidden.
 
static int numPanelsToHide = 0
 The target number of panels to hide.
 

Detailed Description

This is a utilty class for handling specific display functions, such as show/hide node functionality.

Member Function Documentation

◆ HandleHideNode()

static void EasyTalk.Display.DisplayUtils.HandleHideNode ( AsyncNode node,
Dictionary< string, DialoguePanel > displayMap,
EasyTalkDialogueSettings dialogueSettings )
static

Processes the provided Hide node, hiding each panel/character configured for the node.

Parameters
nodeThe Hide node to process.
displayMapA mapping of Display IDs to Dialogue Panels.
dialogueSettingsThe dialogue settings to use.

◆ HandleShowNode()

static void EasyTalk.Display.DisplayUtils.HandleShowNode ( AsyncNode node,
Dictionary< string, DialoguePanel > displayMap,
EasyTalkDialogueSettings dialogueSettings )
static

Processes ths provided Show node, showing each panel/character configured for the node.

Parameters
nodeThe Show node to process.
displayMapA mapping of Display IDs to Dialogue Panels.
dialogueSettingsThe dialogue settings to use.

◆ PanelHidden()

static void EasyTalk.Display.DisplayUtils.PanelHidden ( )
staticprivate

Called when a panel has finished being hidden. After the target counter is reached, ExecutionCompleted() is called on the active Hide node.

◆ PanelShown()

static void EasyTalk.Display.DisplayUtils.PanelShown ( )
staticprivate

Called when a panel has finished being shown. After the target counter is reached, ExecutionCompleted() is called on the active Show node.

Member Data Documentation

◆ activeNode

AsyncNode EasyTalk.Display.DisplayUtils.activeNode
staticprivate

The currently active node.

◆ numPanelsHidden

int EasyTalk.Display.DisplayUtils.numPanelsHidden = 0
staticprivate

The number of panels hidden.

◆ numPanelsShown

int EasyTalk.Display.DisplayUtils.numPanelsShown = 0
staticprivate

The number of panels shown.

◆ numPanelsToHide

int EasyTalk.Display.DisplayUtils.numPanelsToHide = 0
staticprivate

The target number of panels to hide.

◆ numPanelsToShow

int EasyTalk.Display.DisplayUtils.numPanelsToShow = 0
staticprivate

The target number of panels to show.

◆ panelsToHide

List<DialoguePanel> EasyTalk.Display.DisplayUtils.panelsToHide = new List<DialoguePanel>()
staticprivate

A List of panels which are to be hidden.

◆ panelsToShow

List<DialoguePanel> EasyTalk.Display.DisplayUtils.panelsToShow = new List<DialoguePanel>()
staticprivate

A List of panels which are to be shown.