PixelCrushers.QuestMachine.QuestControl Class Reference

Provides methods to control parts of a quest. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestControl:

Collaboration diagram for PixelCrushers.QuestMachine.QuestControl:

Classes
class	ConditionalEvent

Public Member Functions
void	SetQuestState (QuestState state)
	Sets the quest to a state.
void	SetQuestNodeState (QuestNodeState state)
	Sets the quest node to a state.
void	SetQuestCounter (int value)
	Sets a quest counter value.
void	IncrementQuestCounter (int value)
	Increments a quest counter value.
void	SendToMessageSystem (string message)
	Sends a message to the Message System.
void	ShowAlert (string text)
	Shows an alert.
void	TryConditionalEvent ()
	Checks the conditions of the assigned conditional event.
bool	IsConditionMet ()
	Checks if the condition event's conditions are met.

Properties
StringField	questID [get, set]
StringField	questNodeID [get, set]
StringField	counterName [get, set]
ConditionalEvent	conditionalEvent [get, set]

Detailed Description

Provides methods to control parts of a quest.

Member Function Documentation

IncrementQuestCounter()

void PixelCrushers.QuestMachine.QuestControl.IncrementQuestCounter ( int  value )

inline

Increments a quest counter value.

The quest and counter are specified in the questID and counterName properties.

Parameters

value

Value to increment/decrement by.

IsConditionMet()

bool PixelCrushers.QuestMachine.QuestControl.IsConditionMet ( )

inline

Checks if the condition event's conditions are met.

Returns

SendToMessageSystem()

void PixelCrushers.QuestMachine.QuestControl.SendToMessageSystem ( string  message )

inline

Sends a message to the Message System.

If the message contains a colon (:), the part after the colon is sent as the parameter. If it contains a second colon, the part after the second colon is sent as a value.

Parameters

message

SetQuestCounter()

void PixelCrushers.QuestMachine.QuestControl.SetQuestCounter ( int  value )

inline

Sets a quest counter value.

The quest and counter are specified in the questID and counterName properties.

Parameters

value

New value.

SetQuestNodeState()

void PixelCrushers.QuestMachine.QuestControl.SetQuestNodeState ( QuestNodeState  state )

inline

Sets the quest node to a state.

The quest and quest node are specified in the questID and questNodeID properties.

Parameters

state

New state.

SetQuestState()

void PixelCrushers.QuestMachine.QuestControl.SetQuestState ( QuestState  state )

inline

Sets the quest to a state.

The quest is specified in the questID property.

Parameters

state

New state.

ShowAlert()

void PixelCrushers.QuestMachine.QuestControl.ShowAlert ( string  text )

inline

Shows an alert.

Parameters

text	Text to show.

TryConditionalEvent()

void PixelCrushers.QuestMachine.QuestControl.TryConditionalEvent ( )

inline

Checks the conditions of the assigned conditional event.

Property Documentation

conditionalEvent

ConditionalEvent PixelCrushers.QuestMachine.QuestControl.conditionalEvent

getset

counterName

StringField PixelCrushers.QuestMachine.QuestControl.counterName

getset

questID

StringField PixelCrushers.QuestMachine.QuestControl.questID

getset

questNodeID

StringField PixelCrushers.QuestMachine.QuestControl.questNodeID

getset

---

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 MonoBehaviours/Quest Interaction/QuestControl.cs