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

Utility class for procedurally building quests. More...

Public Member Functions

 QuestBuilder (StringField name)
 Creates a new quest.
 
 QuestBuilder (string name)
 Creates a new quest.
 
 QuestBuilder (string name, StringField id, StringField title)
 Creates a new quest.
 
 QuestBuilder (string name, string id, string title)
 Creates a new quest.
 
 QuestBuilder (Quest quest)
 Creates a QuestBuilder for an existing quest.
 
Quest ToQuest ()
 
QuestCounter AddCounter (StringField counterName, int initialValue, int minValue, int maxValue, bool randomizeInitialValue, QuestCounterUpdateMode updateMode)
 
QuestCounter AddCounter (string counterName, int initialValue, int minValue, int maxValue, bool randomizeInitialValue, QuestCounterUpdateMode updateMode)
 
void AddCounterMessageEvent (StringField counterName, StringField targetID, StringField message, StringField parameter, QuestCounterMessageEvent.Operation operation, int literalValue=0)
 
void AddCounterMessageEvent (StringField counterName, string targetID, string message, string parameter, QuestCounterMessageEvent.Operation operation, int literalValue=0)
 
void AddCounterMessageEvent (string counterName, string targetID, string message, string parameter, QuestCounterMessageEvent.Operation operation, int literalValue=0)
 
void AssignRewards (RewardSystem[] rewardSystems, int points)
 
void AddOfferContents (params QuestContent[] contents)
 
void AddOfferUnmetContents (params QuestContent[] contents)
 
void AddContents (QuestContentSet contentSet, params QuestContent[] contents)
 
void AddContents (List< QuestContent > contentList, params QuestContent[] contents)
 
QuestContent CreateTitleContent ()
 
QuestContent CreateHeadingContent (StringField text, int level)
 
QuestContent CreateHeadingContent (string text, int level)
 
QuestContent CreateBodyContent (StringField text)
 
QuestContent CreateBodyContent (string text)
 
QuestNode GetStartNode ()
 
QuestNode AddNode (QuestNode parent, StringField id, StringField internalName, QuestNodeType nodeType, bool isOptional=false)
 
QuestNode AddNode (QuestNode parent, string id, string internalName, QuestNodeType nodeType, bool isOptional=false)
 
QuestNode AddSuccessNode (QuestNode parent)
 
QuestNode AddFailureNode (QuestNode parent)
 
QuestNode AddPassthroughNode (QuestNode parent, StringField id, StringField internalName)
 
QuestNode AddPassthroughNode (QuestNode parent, string id, string internalName)
 
QuestNode AddConditionNode (QuestNode parent, StringField id, StringField internalName, ConditionCountMode conditionCountMode=ConditionCountMode.All, bool isOptional=false)
 
QuestNode AddConditionNode (QuestNode parent, string id, string internalName, ConditionCountMode conditionCountMode=ConditionCountMode.All, bool isOptional=false)
 
QuestNode AddDiscussQuestNode (QuestNode parent, QuestMessageParticipant targetSpecifier, StringField targetID, bool isOptional=false)
 
CounterQuestCondition AddCounterCondition (QuestNode node, StringField counterName, CounterValueConditionMode conditionMode, QuestNumber requiredValue)
 
CounterQuestCondition AddCounterCondition (QuestNode node, StringField counterName, CounterValueConditionMode conditionMode, int requiredValue)
 
CounterQuestCondition AddCounterCondition (QuestNode node, string counterName, CounterValueConditionMode conditionMode, QuestNumber requiredValue)
 
CounterQuestCondition AddCounterCondition (QuestNode node, string counterName, CounterValueConditionMode conditionMode, int requiredValue)
 
MessageQuestCondition AddMessageCondition (QuestNode node, QuestMessageParticipant senderSpecifier, StringField senderID, QuestMessageParticipant targetSpecifier, StringField targetID, StringField message, StringField parameter, MessageValue value=null)
 
MessageQuestCondition AddMessageCondition (QuestNode node, QuestMessageParticipant senderSpecifier, string senderID, QuestMessageParticipant targetSpecifier, string targetID, string message, string parameter, MessageValue value=null)
 
ParentQuestCondition AddParentCondition (QuestNode node, ConditionCountMode parentCountMode, int minParentCount=1)
 
QuestAction CreateAlertAction (StringField text)
 
QuestAction CreateAlertAction (string text)
 
QuestAction CreateMessageAction (StringField message, StringField parameter)
 
QuestAction CreateMessageAction (string message, string parameter)
 
QuestAction CreateMessageAction (StringField text)
 
QuestAction CreateMessageAction (string text)
 
QuestAction CreateSetIndicatorAction (StringField questID, StringField entityID, QuestIndicatorState indicatorState)
 

Properties

Quest quest [get, set]
 

Detailed Description

Utility class for procedurally building quests.

Constructor & Destructor Documentation

◆ QuestBuilder() [1/5]

PixelCrushers.QuestMachine.QuestBuilder.QuestBuilder ( StringField  name)
inline

Creates a new quest.

Parameters
nameName to use for quest name, ID, and title.

◆ QuestBuilder() [2/5]

PixelCrushers.QuestMachine.QuestBuilder.QuestBuilder ( string  name)
inline

Creates a new quest.

Parameters
nameName to use for quest name, ID, and title.

◆ QuestBuilder() [3/5]

PixelCrushers.QuestMachine.QuestBuilder.QuestBuilder ( string  name,
StringField  id,
StringField  title 
)
inline

Creates a new quest.

Parameters
nameQuest name.
idQuest ID.
titleQuest title (visible in UIs).

◆ QuestBuilder() [4/5]

PixelCrushers.QuestMachine.QuestBuilder.QuestBuilder ( string  name,
string  id,
string  title 
)
inline

Creates a new quest.

Parameters
nameQuest name.
idQuest ID.
titleQuest title (visible in UIs).

◆ QuestBuilder() [5/5]

PixelCrushers.QuestMachine.QuestBuilder.QuestBuilder ( Quest  quest)
inline

Creates a QuestBuilder for an existing quest.

Use this form to add new content to an existing quest.

Parameters
questThe quest to edit.

Member Function Documentation

◆ AddConditionNode() [1/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddConditionNode ( QuestNode  parent,
string  id,
string  internalName,
ConditionCountMode  conditionCountMode = ConditionCountMode::All,
bool  isOptional = false 
)
inline

◆ AddConditionNode() [2/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddConditionNode ( QuestNode  parent,
StringField  id,
StringField  internalName,
ConditionCountMode  conditionCountMode = ConditionCountMode::All,
bool  isOptional = false 
)
inline

◆ AddContents() [1/2]

void PixelCrushers.QuestMachine.QuestBuilder.AddContents ( List< QuestContent >  contentList,
params QuestContent[]  contents 
)
inline

◆ AddContents() [2/2]

void PixelCrushers.QuestMachine.QuestBuilder.AddContents ( QuestContentSet  contentSet,
params QuestContent[]  contents 
)
inline

◆ AddCounter() [1/2]

QuestCounter PixelCrushers.QuestMachine.QuestBuilder.AddCounter ( string  counterName,
int  initialValue,
int  minValue,
int  maxValue,
bool  randomizeInitialValue,
QuestCounterUpdateMode  updateMode 
)
inline

◆ AddCounter() [2/2]

QuestCounter PixelCrushers.QuestMachine.QuestBuilder.AddCounter ( StringField  counterName,
int  initialValue,
int  minValue,
int  maxValue,
bool  randomizeInitialValue,
QuestCounterUpdateMode  updateMode 
)
inline

◆ AddCounterCondition() [1/4]

CounterQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddCounterCondition ( QuestNode  node,
string  counterName,
CounterValueConditionMode  conditionMode,
int  requiredValue 
)
inline

◆ AddCounterCondition() [2/4]

CounterQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddCounterCondition ( QuestNode  node,
string  counterName,
CounterValueConditionMode  conditionMode,
QuestNumber  requiredValue 
)
inline

◆ AddCounterCondition() [3/4]

CounterQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddCounterCondition ( QuestNode  node,
StringField  counterName,
CounterValueConditionMode  conditionMode,
int  requiredValue 
)
inline

◆ AddCounterCondition() [4/4]

CounterQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddCounterCondition ( QuestNode  node,
StringField  counterName,
CounterValueConditionMode  conditionMode,
QuestNumber  requiredValue 
)
inline

◆ AddCounterMessageEvent() [1/3]

void PixelCrushers.QuestMachine.QuestBuilder.AddCounterMessageEvent ( string  counterName,
string  targetID,
string  message,
string  parameter,
QuestCounterMessageEvent::Operation  operation,
int  literalValue = 0 
)
inline

◆ AddCounterMessageEvent() [2/3]

void PixelCrushers.QuestMachine.QuestBuilder.AddCounterMessageEvent ( StringField  counterName,
string  targetID,
string  message,
string  parameter,
QuestCounterMessageEvent::Operation  operation,
int  literalValue = 0 
)
inline

◆ AddCounterMessageEvent() [3/3]

void PixelCrushers.QuestMachine.QuestBuilder.AddCounterMessageEvent ( StringField  counterName,
StringField  targetID,
StringField  message,
StringField  parameter,
QuestCounterMessageEvent::Operation  operation,
int  literalValue = 0 
)
inline

◆ AddDiscussQuestNode()

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddDiscussQuestNode ( QuestNode  parent,
QuestMessageParticipant  targetSpecifier,
StringField  targetID,
bool  isOptional = false 
)
inline

◆ AddFailureNode()

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddFailureNode ( QuestNode  parent)
inline

◆ AddMessageCondition() [1/2]

MessageQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddMessageCondition ( QuestNode  node,
QuestMessageParticipant  senderSpecifier,
string  senderID,
QuestMessageParticipant  targetSpecifier,
string  targetID,
string  message,
string  parameter,
MessageValue  value = null 
)
inline

◆ AddMessageCondition() [2/2]

MessageQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddMessageCondition ( QuestNode  node,
QuestMessageParticipant  senderSpecifier,
StringField  senderID,
QuestMessageParticipant  targetSpecifier,
StringField  targetID,
StringField  message,
StringField  parameter,
MessageValue  value = null 
)
inline

◆ AddNode() [1/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddNode ( QuestNode  parent,
string  id,
string  internalName,
QuestNodeType  nodeType,
bool  isOptional = false 
)
inline

◆ AddNode() [2/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddNode ( QuestNode  parent,
StringField  id,
StringField  internalName,
QuestNodeType  nodeType,
bool  isOptional = false 
)
inline

◆ AddOfferContents()

void PixelCrushers.QuestMachine.QuestBuilder.AddOfferContents ( params QuestContent[]  contents)
inline

◆ AddOfferUnmetContents()

void PixelCrushers.QuestMachine.QuestBuilder.AddOfferUnmetContents ( params QuestContent[]  contents)
inline

◆ AddParentCondition()

ParentQuestCondition PixelCrushers.QuestMachine.QuestBuilder.AddParentCondition ( QuestNode  node,
ConditionCountMode  parentCountMode,
int  minParentCount = 1 
)
inline

◆ AddPassthroughNode() [1/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddPassthroughNode ( QuestNode  parent,
string  id,
string  internalName 
)
inline

◆ AddPassthroughNode() [2/2]

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddPassthroughNode ( QuestNode  parent,
StringField  id,
StringField  internalName 
)
inline

◆ AddSuccessNode()

QuestNode PixelCrushers.QuestMachine.QuestBuilder.AddSuccessNode ( QuestNode  parent)
inline

◆ AssignRewards()

void PixelCrushers.QuestMachine.QuestBuilder.AssignRewards ( RewardSystem[]  rewardSystems,
int  points 
)
inline

◆ CreateAlertAction() [1/2]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateAlertAction ( string  text)
inline

◆ CreateAlertAction() [2/2]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateAlertAction ( StringField  text)
inline

◆ CreateBodyContent() [1/2]

QuestContent PixelCrushers.QuestMachine.QuestBuilder.CreateBodyContent ( string  text)
inline

◆ CreateBodyContent() [2/2]

QuestContent PixelCrushers.QuestMachine.QuestBuilder.CreateBodyContent ( StringField  text)
inline

◆ CreateHeadingContent() [1/2]

QuestContent PixelCrushers.QuestMachine.QuestBuilder.CreateHeadingContent ( string  text,
int  level 
)
inline

◆ CreateHeadingContent() [2/2]

QuestContent PixelCrushers.QuestMachine.QuestBuilder.CreateHeadingContent ( StringField  text,
int  level 
)
inline

◆ CreateMessageAction() [1/4]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateMessageAction ( string  message,
string  parameter 
)
inline

◆ CreateMessageAction() [2/4]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateMessageAction ( string  text)
inline

◆ CreateMessageAction() [3/4]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateMessageAction ( StringField  message,
StringField  parameter 
)
inline

◆ CreateMessageAction() [4/4]

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateMessageAction ( StringField  text)
inline

◆ CreateSetIndicatorAction()

QuestAction PixelCrushers.QuestMachine.QuestBuilder.CreateSetIndicatorAction ( StringField  questID,
StringField  entityID,
QuestIndicatorState  indicatorState 
)
inline

◆ CreateTitleContent()

QuestContent PixelCrushers.QuestMachine.QuestBuilder.CreateTitleContent ( )
inline

◆ GetStartNode()

QuestNode PixelCrushers.QuestMachine.QuestBuilder.GetStartNode ( )
inline

◆ ToQuest()

Quest PixelCrushers.QuestMachine.QuestBuilder.ToQuest ( )
inline

Property Documentation

◆ quest

Quest PixelCrushers.QuestMachine.QuestBuilder.quest
getset
The documentation for this class was generated from the following file: