All Classes Namespaces Functions Variables Enumerations Enumerator Properties
DiaQ.DiaQuestCondition Class Reference

A DiaQ Quest Condition to complete. You should use the functions in DiaQuest and not interact with the condition directly, except when you want to interact with the metaData. If you change value here directly the quest might not pick up on the state change of the condition and not be able to update whether the quest is completed More...

Inherits plyCommon.plyMetaDataInterface.

Public Member Functions

void Awake ()
 called by Quest's Awake at runtime More...
 
Dictionary< string, plyMetaDataAllMetaData ()
 
List< plyMetaDataAllMetaDataList ()
 
plyMetaData GetMetaData (string name)
 Return reference to meta data object. Null if not found. More...
 
object GetMetaDataValue (string name)
 Return meta data value. Null if named meta data not found. More...
 
void SetMetaDataValue (string name, object val)
 Set meta data value. Will create the named meta data if not found and then set value. More...
 
string ParsedConditionText ()
 Return parsed text. The inline values will be inserted if any present in text. More...
 

Public Attributes

string key = ""
 identifies the condition More...
 
int targetValue = 1
 most quests have to do with collecting or doing something a number of times. This field can be used to indicate the amount needed. More...
 
string text = ""
 Text associated with the condition More...
 
plyMetaData[] metaData = new plyMetaData[0]
 Extra data that can be associated with the condition. Do not access at runtime, use provided functions. More...
 

Properties

bool completed [get, set]
 Indicates that this condition is met. will not reset progress if set to false. More...
 
int performedTimes [get, set]
 how many times the condition has been performed. Once this value reaches targetValue the condition will be considered completed More...
 
Dictionary< string, plyMetaDataruntimeMetaData [get, set]
 

Detailed Description

A DiaQ Quest Condition to complete. You should use the functions in DiaQuest and not interact with the condition directly, except when you want to interact with the metaData. If you change value here directly the quest might not pick up on the state change of the condition and not be able to update whether the quest is completed

Member Function Documentation

void DiaQ.DiaQuestCondition.Awake ( )

called by Quest's Awake at runtime

plyMetaData DiaQ.DiaQuestCondition.GetMetaData ( string  name)

Return reference to meta data object. Null if not found.

Implements plyCommon.plyMetaDataInterface.

object DiaQ.DiaQuestCondition.GetMetaDataValue ( string  name)

Return meta data value. Null if named meta data not found.

Implements plyCommon.plyMetaDataInterface.

string DiaQ.DiaQuestCondition.ParsedConditionText ( )

Return parsed text. The inline values will be inserted if any present in text.

void DiaQ.DiaQuestCondition.SetMetaDataValue ( string  name,
object  val 
)

Set meta data value. Will create the named meta data if not found and then set value.

Implements plyCommon.plyMetaDataInterface.

Member Data Documentation

string DiaQ.DiaQuestCondition.key = ""

identifies the condition

plyMetaData [] DiaQ.DiaQuestCondition.metaData = new plyMetaData[0]

Extra data that can be associated with the condition. Do not access at runtime, use provided functions.

int DiaQ.DiaQuestCondition.targetValue = 1

most quests have to do with collecting or doing something a number of times. This field can be used to indicate the amount needed.

string DiaQ.DiaQuestCondition.text = ""

Text associated with the condition

Property Documentation

bool DiaQ.DiaQuestCondition.completed
getset

Indicates that this condition is met. will not reset progress if set to false.

int DiaQ.DiaQuestCondition.performedTimes
getset

how many times the condition has been performed. Once this value reaches targetValue the condition will be considered completed