EasyTalk API
Loading...
Searching...
No Matches
EasyTalk.Nodes.Flow.PathSelectorNode Class Reference

A node which allows a dialogue flow path to be chosen based on the index of the path set on the node. More...

Inherits EasyTalk.Nodes.Core.ListNode, and EasyTalk.Nodes.Core.DialogueFlowNode.

Public Member Functions

 PathSelectorNode ()
 Creates a new PathSelectorNode.
 
void FindIndex (Dictionary< int, object > nodeValues)
 Determines the index of the dialogoue flow path to use.
 
NodeConnection GetFlowInput ()
 Returns the dialogue flow input for the node.
Returns
The dialogue flow input for the node.

 
NodeConnection GetFlowOutput ()
 Returns the dialogue flow output for the node.
Returns
The dialogue flow output for the node.

 
- Public Member Functions inherited from EasyTalk.Nodes.Core.ListNode
 ListNode ()
 Creates a new ListNode.
 
virtual void AddItem (ListItem item)
 Adds the specified item to this node's List of items.
 
void RemoveItem (ListItem item)
 Removes the specified item from this node's List of items.
 
void RemoveItem (int index)
 Removes the item at the specified index from this node.
 
void RemoveAllItems ()
 Removes all items from the node.
 
- Public Member Functions inherited from EasyTalk.Nodes.Core.Node
void AddInput (NodeConnection input)
 Adds the provided input connection to the node's inputs.
 
void AddOutput (NodeConnection output)
 Adds the provided output connection to the node's outputs.
 
NodeConnection AddInput (InputOutputType connectionType)
 Adds a new input connection of the specified type to the node's inputs.
 
NodeConnection AddOutput (InputOutputType connectionType)
 Adds a new output connection of the specified type to the node's outputs.
 
NodeConnection FindOutputOfType (InputOutputType outputType)
 Finds the first output which matches the specified output type.
 
NodeConnection FindInputOfType (InputOutputType inputType)
 Finds the first input which matches the specified input type.
 
bool HasConnectedInputs ()
 Returns true if this node has inputs which are connected to other node outputs.
 
bool HasConnectedOutputs ()
 Returns true if this node has outputs which are connected to other node inputs.
 
List< int > FindDependencyOutputIDs ()
 Finds and returns a List of all output IDs which are connected to this node's value (non-dialogue-flow) inputs.
 
string GetJSON ()
 Returns a JSON string representation of the node.
 

Properties

string Index [get, set]
 Gets or sets the index of the dialogue flow path to proceed down.
 
- Properties inherited from EasyTalk.Nodes.Core.ListNode
List< ListItemItems [get, set]
 Gets or sets the List of items in this node.
 
- Properties inherited from EasyTalk.Nodes.Core.Node
int ID [get, set]
 Gets or sets the node ID.
 
string NodeTypeString [get, set]
 Gets or sets the node type string.
 
float XPosition [get, set]
 Gets or sets the X position of the node.
 
float YPosition [get, set]
 Gets or sets the Y position of the node.
 
string Name [get, set]
 Gets or sets the name of the node.
 
float Width [get, set]
 Gets or sets the width of the node.
 
float Height [get, set]
 Gets or sets the height of the node.
 
NodeType NodeType [get, set]
 Gets or sets the node type.
 
List< NodeConnectionInputs [get, set]
 Gets or sets the List of input connections of the node.
 
List< NodeConnectionOutputs [get, set]
 Gets or sets the List of output connections of the node.
 

Private Attributes

string indexValue = "0"
 The string value of the index.
 
int index = 0
 The index of the dialogue flow path which should be proceeded down.
 

Additional Inherited Members

- Static Public Member Functions inherited from EasyTalk.Nodes.Core.Node
static Node Deserialize (string json)
 Deserializes a Node from the specified JSON string.
 
- Protected Member Functions inherited from EasyTalk.Nodes.Core.Node
List< NodeConnectionFindFlowInputs ()
 Finds and returns a List of all inputs which are dialogue flow inputs.
 
List< NodeConnectionFindFlowOutputs ()
 Finds and returns a List of all outputs which are dialogue flow outputs.
 
- Protected Attributes inherited from EasyTalk.Nodes.Core.ListNode
List< ListItemitems = new List<ListItem>()
 The items in the node.
 
- Protected Attributes inherited from EasyTalk.Nodes.Core.Node
int nodeId = NodeUtils.NextID()
 The ID of the node.
 
string name
 The name of the node.
 
NodeType nodeType
 The type of the node.
 
List< NodeConnectioninputs = new List<NodeConnection>()
 A List of input connections of the node.
 
List< NodeConnectionoutputs = new List<NodeConnection>()
 A List of output connections of the node.
 

Detailed Description

A node which allows a dialogue flow path to be chosen based on the index of the path set on the node.

Constructor & Destructor Documentation

◆ PathSelectorNode()

EasyTalk.Nodes.Flow.PathSelectorNode.PathSelectorNode ( )

Creates a new PathSelectorNode.

Member Function Documentation

◆ FindIndex()

void EasyTalk.Nodes.Flow.PathSelectorNode.FindIndex ( Dictionary< int, object > nodeValues)

Determines the index of the dialogoue flow path to use.

Parameters
nodeValuesA collection of node and connection IDs to their corresponding values.

◆ GetFlowInput()

NodeConnection EasyTalk.Nodes.Flow.PathSelectorNode.GetFlowInput ( )

Returns the dialogue flow input for the node.

Returns
The dialogue flow input for the node.

Implements EasyTalk.Nodes.Core.DialogueFlowNode.

◆ GetFlowOutput()

NodeConnection EasyTalk.Nodes.Flow.PathSelectorNode.GetFlowOutput ( )

Returns the dialogue flow output for the node.

Returns
The dialogue flow output for the node.

Implements EasyTalk.Nodes.Core.DialogueFlowNode.

Member Data Documentation

◆ index

int EasyTalk.Nodes.Flow.PathSelectorNode.index = 0
private

The index of the dialogue flow path which should be proceeded down.

◆ indexValue

string EasyTalk.Nodes.Flow.PathSelectorNode.indexValue = "0"
private

The string value of the index.

Property Documentation

◆ Index

string EasyTalk.Nodes.Flow.PathSelectorNode.Index
getset

Gets or sets the index of the dialogue flow path to proceed down.