PixelCrushers.QuestMachine.QuestNumber Class Reference

References a literal value or quest counter value. More...

Public Types
enum	ValueType { Literal , CounterValue , CounterMinValue , CounterMaxValue }

Public Member Functions
int	GetValue (Quest quest)
	Returns the current value of this quest number.
	QuestNumber ()
	QuestNumber (int literalValue)
	Creates a quest number corresponding to a literal integer value.
	QuestNumber (Quest quest, string counterName)
	Creates a quest number corresponding to the current counter value of a quest counter.
	QuestNumber (Quest quest, StringField counterName, ValueType valueType)
	Creates a quest number corresponding to a specified type of value of a quest counter.
string	GetEditorName (Quest quest)

Properties
ValueType	valueType [get, set]
	The source of this number's value.
int	literalValue [get, set]
	Literal value.
int	counterIndex [get, set]
	A counter defined in the quest.

Detailed Description

References a literal value or quest counter value.

Member Enumeration Documentation

ValueType

enum PixelCrushers.QuestMachine.QuestNumber.ValueType

Enumerator
Literal
CounterValue
CounterMinValue
CounterMaxValue

Constructor & Destructor Documentation

QuestNumber() [1/4]

PixelCrushers.QuestMachine.QuestNumber.QuestNumber ( )

inline

QuestNumber() [2/4]

PixelCrushers.QuestMachine.QuestNumber.QuestNumber ( int  literalValue )

inline

Creates a quest number corresponding to a literal integer value.

Parameters

literalValue

QuestNumber() [3/4]

PixelCrushers.QuestMachine.QuestNumber.QuestNumber ( Quest  quest, string  counterName  )

inline

Creates a quest number corresponding to the current counter value of a quest counter.

Parameters

quest	Quest containing the counter.
counterName	Name of the counter.

QuestNumber() [4/4]

PixelCrushers.QuestMachine.QuestNumber.QuestNumber ( Quest  quest, StringField  counterName, ValueType  valueType  )

inline

Creates a quest number corresponding to a specified type of value of a quest counter.

Parameters

quest	Quest containing the counter.
counterName	Name of the counter.
valueType	The value type (current, min, or max).

Member Function Documentation

GetEditorName()

string PixelCrushers.QuestMachine.QuestNumber.GetEditorName ( Quest  quest )

inline

GetValue()

int PixelCrushers.QuestMachine.QuestNumber.GetValue ( Quest  quest )

inline

Returns the current value of this quest number.

Parameters

quest

The quest to which this quest number pertains.

Property Documentation

counterIndex

int PixelCrushers.QuestMachine.QuestNumber.counterIndex

getset

A counter defined in the quest.

literalValue

int PixelCrushers.QuestMachine.QuestNumber.literalValue

getset

Literal value.

valueType

ValueType PixelCrushers.QuestMachine.QuestNumber.valueType

getset

The source of this number's value.

---

The documentation for this class was generated from the following file:

• C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest/Quest Counter/QuestNumber.cs