EasyTalk API
Loading...
Searching...
No Matches
EasyTalk.Nodes.Tags.NodeTag Class Reference

Base class implementation defining common features for node tags which modify how dialogue nodes are processed during gameplay. More...

Inherited by EasyTalk.Nodes.Tags.DisplayTag, EasyTalk.Nodes.Tags.KeyTag, EasyTalk.Nodes.Tags.NameTag, EasyTalk.Nodes.Tags.SelectableTag, EasyTalk.Nodes.Tags.TargetTag, and EasyTalk.Nodes.Tags.TranslateTag.

Public Member Functions

 NodeTag (string tagName)
 Creates a new NodeTag with the specified tag name.
 

Static Public Member Functions

static string ExtractTags (string text, Dictionary< string, NodeTag > tags)
 Extracts all node tags from the provided string and stores them in a Dictionary, where the key is the tag name and the value is the node tag itself.
 
static string RemoveTags (string text)
 Creates and returns a version of the provided string with all of the node tags removed.
 
static string ExtractTag (string text, string tagName, out NodeTag tag)
 Extracts the specified node tag type from the provided string and stores it in the NodeTag specified.
 
static NodeTag CreateTag (string tagName, string value)
 Creates a new NodeTag of the specified type with the value provided.
 

Public Attributes

string tagName
 The name of the tag.
 

Detailed Description

Base class implementation defining common features for node tags which modify how dialogue nodes are processed during gameplay.

Constructor & Destructor Documentation

◆ NodeTag()

EasyTalk.Nodes.Tags.NodeTag.NodeTag ( string tagName)

Creates a new NodeTag with the specified tag name.

Parameters
tagNameThe tag name.

Member Function Documentation

◆ CreateTag()

static NodeTag EasyTalk.Nodes.Tags.NodeTag.CreateTag ( string tagName,
string value )
static

Creates a new NodeTag of the specified type with the value provided.

Parameters
tagNameThe name of the tag type to create.
valueThe value to set on the created node tag.
Returns
The created NodeTag.

◆ ExtractTag()

static string EasyTalk.Nodes.Tags.NodeTag.ExtractTag ( string text,
string tagName,
out NodeTag tag )
static

Extracts the specified node tag type from the provided string and stores it in the NodeTag specified.

Parameters
textThe string to extract a node tag from.
tagNameThe name of the tag type to extract.
tagThe NodeTag to store the tag's value(s) in.
Returns
A version of the original string with the specified node tag removed.

◆ ExtractTags()

static string EasyTalk.Nodes.Tags.NodeTag.ExtractTags ( string text,
Dictionary< string, NodeTag > tags )
static

Extracts all node tags from the provided string and stores them in a Dictionary, where the key is the tag name and the value is the node tag itself.

Parameters
textThe string to extract tags from.
tagsA Dictionary to store extracted node tags in.
Returns
A version of the original string with all node tags removed.

◆ RemoveTags()

static string EasyTalk.Nodes.Tags.NodeTag.RemoveTags ( string text)
static

Creates and returns a version of the provided string with all of the node tags removed.

Parameters
textThe string to remove node tags from.
Returns
A version of the original string with all node tags removed.

Member Data Documentation

◆ tagName

string EasyTalk.Nodes.Tags.NodeTag.tagName

The name of the tag.