Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | Properties | List of all members
PixelCrushers.QuestMachine.QuestMachineTags Class Reference

Quest Machine-specific string constants (tags) and utility methods to replace tags with their runtime values. More...

Collaboration diagram for PixelCrushers.QuestMachine.QuestMachineTags:
Collaboration graph
[legend]

Static Public Member Functions

static StringField GetIDBySpecifier (QuestMessageParticipant specifier, StringField id)
 Returns the ID string (pre-ReplaceTags) for a participant specifier.
 
static void AddTagsToDictionary (TagDictionary staticTags, StringField stringField)
 Adds any tags in a StringField to a dictionary.
 
static void AddTagsToDictionary (TagDictionary staticTags, string s)
 Adds any tags in a string to a dictionary.
 
static void AddTagValuesToDictionary (TagDictionary tagDictionary, TextTable textTable)
 Associates tags in a tag dictionary with values from a primary text table (i.e., quest giver's text table), or failing that QuestMachine's default text table, or failing that the tag name itself.
 
static string ReplaceTags (StringField stringField, Quest quest)
 Replaces the tags in a StringField.
 
static string ReplaceTags (string s, Quest quest)
 Replaces the tags in a string.
 
static string SecondsToTimeString (int seconds)
 Converts seconds into DD HH:MM:SS time format.
 
static void AddQuestTagsToTextTable (Quest quest, TextTable textTable)
 
static void AddQuestTagsToTextTable (List< QuestNode > nodeList, TextTable textTable)
 
static void AddQuestTagsToTextTable (QuestNode node, TextTable textTable)
 
static void AddQuestTagsToTextTable (List< QuestStateInfo > stateInfoList, TextTable textTable)
 
static void AddQuestTagsToTextTable (QuestStateInfo stateInfo, TextTable textTable)
 
static void AddQuestTagsToTextTable (QuestContentSet contentSet, TextTable textTable)
 
static void AddQuestTagsToTextTable (List< QuestContent > contentList, TextTable textTable)
 
static void AddQuestTagsToTextTable (QuestContent content, TextTable textTable)
 
static void AddQuestTagsToTextTable (StringField stringField, TextTable textTable)
 
static void AddQuestTagsToTextTable (string s, TextTable textTable)
 

Static Public Attributes

const string TagPrefix = @"{"
 All tags start with an open brace.
 
const string CounterValueTagPrefix = @"{#"
 All counter value tags start with an open brace and hash sign.
 
const string CounterMinValueTagPrefix = @"{<#"
 All counter min value tags start with an open brace and less-than sign.
 
const string CounterMaxValueTagPrefix = @"{>#"
 All counter max value tags start with an open brace and greater-than sign.
 
const string CounterTimeValueTagPrefix = @"{:"
 Tag to show a counter value as HH:MM:SS time.
 
const string CounterTagQuestNameSeparator = @":"
 Separator character between quest name and counter name.
 
const string QUESTID = @"{QUESTID}"
 The quest's ID.
 
const string QUEST = @"{QUEST}"
 The quest's title.
 
const string QUESTGIVER = @"{QUESTGIVER}"
 The display name of the quest's giver.
 
const string QUESTGIVERID = @"{QUESTGIVERID}"
 The ID of the quest's giver.
 
const string QUESTER = @"{QUESTER}"
 The display name of the quester.
 
const string QUESTERID = @"{QUESTERID}"
 The ID of the quest's quester.
 
const string GREETERID = @"{GREETERID}"
 The ID of the quester who is greeting the quest giver.
 
const string GREETER = @"{GREETER}"
 The display name of the quester who is greeting the quest giver.
 
const string DOMAIN = @"{DOMAIN}"
 
const string ACTION = @"{ACTION}"
 
const string TARGETDESCRIPTOR = @"{TARGETDESCRIPTOR}"
 
const string TARGET = @"{TARGET}"
 
const string TARGETS = @"{TARGETS}"
 
const string COUNTERGOAL = @"{COUNTERGOAL}"
 
const string REWARD = @"{REWARD}"
 
static StringField QuestGiverIDStringField = new StringField(QUESTGIVERID)
 
static StringField QuesterIDStringField = new StringField(QUESTERID)
 

Properties

static TextTable fallbackTextTable [get, set]
 

Detailed Description

Quest Machine-specific string constants (tags) and utility methods to replace tags with their runtime values.

Member Function Documentation

◆ AddQuestTagsToTextTable() [1/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( List< QuestContent >  contentList,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [2/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( List< QuestNode >  nodeList,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [3/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( List< QuestStateInfo >  stateInfoList,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [4/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( Quest  quest,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [5/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( QuestContent  content,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [6/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( QuestContentSet  contentSet,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [7/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( QuestNode  node,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [8/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( QuestStateInfo  stateInfo,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [9/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( string  s,
TextTable  textTable 
)
inlinestatic

◆ AddQuestTagsToTextTable() [10/10]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddQuestTagsToTextTable ( StringField  stringField,
TextTable  textTable 
)
inlinestatic

◆ AddTagsToDictionary() [1/2]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddTagsToDictionary ( TagDictionary  staticTags,
string  s 
)
inlinestatic

Adds any tags in a string to a dictionary.

Parameters
staticTagsDictionary.
stringFieldstring to scan for tags.

◆ AddTagsToDictionary() [2/2]

static void PixelCrushers.QuestMachine.QuestMachineTags.AddTagsToDictionary ( TagDictionary  staticTags,
StringField  stringField 
)
inlinestatic

Adds any tags in a StringField to a dictionary.

Parameters
staticTagsDictionary.
stringFieldStringField to scan for tags.

◆ AddTagValuesToDictionary()

static void PixelCrushers.QuestMachine.QuestMachineTags.AddTagValuesToDictionary ( TagDictionary  tagDictionary,
TextTable  textTable 
)
inlinestatic

Associates tags in a tag dictionary with values from a primary text table (i.e., quest giver's text table), or failing that QuestMachine's default text table, or failing that the tag name itself.

Leaves ID tags such as {QUESTERID} untouched.

Parameters
tagDictionaryThe tag dictionary containing tags that need values assigned.
textTableThe primary text table from which to look up values.

◆ GetIDBySpecifier()

static StringField PixelCrushers.QuestMachine.QuestMachineTags.GetIDBySpecifier ( QuestMessageParticipant  specifier,
StringField  id 
)
inlinestatic

Returns the ID string (pre-ReplaceTags) for a participant specifier.

Parameters
specifier
id
Returns

◆ ReplaceTags() [1/2]

static string PixelCrushers.QuestMachine.QuestMachineTags.ReplaceTags ( string  s,
Quest  quest 
)
inlinestatic

Replaces the tags in a string.

Returns
A string in which the tags have been replaced with their current values.

◆ ReplaceTags() [2/2]

static string PixelCrushers.QuestMachine.QuestMachineTags.ReplaceTags ( StringField  stringField,
Quest  quest 
)
inlinestatic

Replaces the tags in a StringField.

Returns
A string in which the tags have been replaced with their current values.

◆ SecondsToTimeString()

static string PixelCrushers.QuestMachine.QuestMachineTags.SecondsToTimeString ( int  seconds)
inlinestatic

Converts seconds into DD HH:MM:SS time format.

Member Data Documentation

◆ ACTION

const string PixelCrushers.QuestMachine.QuestMachineTags.ACTION = @"{ACTION}"
static

◆ COUNTERGOAL

const string PixelCrushers.QuestMachine.QuestMachineTags.COUNTERGOAL = @"{COUNTERGOAL}"
static

◆ CounterMaxValueTagPrefix

const string PixelCrushers.QuestMachine.QuestMachineTags.CounterMaxValueTagPrefix = @"{>#"
static

All counter max value tags start with an open brace and greater-than sign.

◆ CounterMinValueTagPrefix

const string PixelCrushers.QuestMachine.QuestMachineTags.CounterMinValueTagPrefix = @"{<#"
static

All counter min value tags start with an open brace and less-than sign.

◆ CounterTagQuestNameSeparator

const string PixelCrushers.QuestMachine.QuestMachineTags.CounterTagQuestNameSeparator = @":"
static

Separator character between quest name and counter name.

◆ CounterTimeValueTagPrefix

const string PixelCrushers.QuestMachine.QuestMachineTags.CounterTimeValueTagPrefix = @"{:"
static

Tag to show a counter value as HH:MM:SS time.

Format can be {:counter} or {:questID:counter}.

Examples:

  • {:secondsLeft}

◆ CounterValueTagPrefix

const string PixelCrushers.QuestMachine.QuestMachineTags.CounterValueTagPrefix = @"{#"
static

All counter value tags start with an open brace and hash sign.

Format can be {#counter} or {#questID:counter}.

Examples:

  • {#numOrcsKilled}
  • {#farming:numApplesPicked}

◆ DOMAIN

const string PixelCrushers.QuestMachine.QuestMachineTags.DOMAIN = @"{DOMAIN}"
static

◆ GREETER

const string PixelCrushers.QuestMachine.QuestMachineTags.GREETER = @"{GREETER}"
static

The display name of the quester who is greeting the quest giver.

◆ GREETERID

const string PixelCrushers.QuestMachine.QuestMachineTags.GREETERID = @"{GREETERID}"
static

The ID of the quester who is greeting the quest giver.

◆ QUEST

const string PixelCrushers.QuestMachine.QuestMachineTags.QUEST = @"{QUEST}"
static

The quest's title.

◆ QUESTER

const string PixelCrushers.QuestMachine.QuestMachineTags.QUESTER = @"{QUESTER}"
static

The display name of the quester.

◆ QUESTERID

const string PixelCrushers.QuestMachine.QuestMachineTags.QUESTERID = @"{QUESTERID}"
static

The ID of the quest's quester.

◆ QuesterIDStringField

StringField PixelCrushers.QuestMachine.QuestMachineTags.QuesterIDStringField = new StringField(QUESTERID)
static

◆ QUESTGIVER

const string PixelCrushers.QuestMachine.QuestMachineTags.QUESTGIVER = @"{QUESTGIVER}"
static

The display name of the quest's giver.

◆ QUESTGIVERID

const string PixelCrushers.QuestMachine.QuestMachineTags.QUESTGIVERID = @"{QUESTGIVERID}"
static

The ID of the quest's giver.

◆ QuestGiverIDStringField

StringField PixelCrushers.QuestMachine.QuestMachineTags.QuestGiverIDStringField = new StringField(QUESTGIVERID)
static

◆ QUESTID

const string PixelCrushers.QuestMachine.QuestMachineTags.QUESTID = @"{QUESTID}"
static

The quest's ID.

◆ REWARD

const string PixelCrushers.QuestMachine.QuestMachineTags.REWARD = @"{REWARD}"
static

◆ TagPrefix

const string PixelCrushers.QuestMachine.QuestMachineTags.TagPrefix = @"{"
static

All tags start with an open brace.

Examples:

  • {QUESTGIVER}: Name of quest's giver.
  • {Hello}: Looks up "Hello" in the default text table.
  • {#numOrcsKilled}: Counter value.

◆ TARGET

const string PixelCrushers.QuestMachine.QuestMachineTags.TARGET = @"{TARGET}"
static

◆ TARGETDESCRIPTOR

const string PixelCrushers.QuestMachine.QuestMachineTags.TARGETDESCRIPTOR = @"{TARGETDESCRIPTOR}"
static

◆ TARGETS

const string PixelCrushers.QuestMachine.QuestMachineTags.TARGETS = @"{TARGETS}"
static

Property Documentation

◆ fallbackTextTable

TextTable PixelCrushers.QuestMachine.QuestMachineTags.fallbackTextTable
staticgetset
The documentation for this class was generated from the following file: