Difference between revisions of "Script/QuestJournal"

From SF3
Jump to: navigation, search
(Created page with "==class QuestJournal== Provides an interface to interact with the player's quest journal, access quest states, etc. === Class Methods === {| border='0' style ='border:solid...")
 
 
(One intermediate revision by the same user not shown)
Line 11: Line 11:
 
| style = 'color: #505050; line-height: 0.5;' |''is the given quest currently active (i.e. in the player's journal)''
 
| style = 'color: #505050; line-height: 0.5;' |''is the given quest currently active (i.e. in the player's journal)''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  
 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateQuest''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|bool]] ''_bActive'' = true)
 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateQuest''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|bool]] ''_bActive'' = true)
 
|-
 
|-
Line 17: Line 17:
 
| style = 'color: #505050; line-height: 0.5;' |''activate or deactivate the given quest (start/cancel the quest)''
 
| style = 'color: #505050; line-height: 0.5;' |''activate or deactivate the given quest (start/cancel the quest)''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|EQuestState]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#EQuestState|EQuestState]]  
 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetQuestState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'') const
 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetQuestState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'') const
 
|-
 
|-
Line 23: Line 23:
 
| style = 'color: #505050; line-height: 0.5;' |''get current state of the given quest''
 
| style = 'color: #505050; line-height: 0.5;' |''get current state of the given quest''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|EQuestState]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  
| style='color: black; width: 90%; line-height: 1.0;' | '''SetQuestState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|EQuestState]] ''_State'')
+
| style='color: black; width: 90%; line-height: 1.0;' | '''SetQuestState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../LogicEnums#EQuestState|EQuestState]] ''_State'')
 
|-
 
|-
 
|
 
|
Line 35: Line 35:
 
| style = 'color: #505050; line-height: 0.5;' |''is the given task currently active?''
 
| style = 'color: #505050; line-height: 0.5;' |''is the given task currently active?''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  
 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateTask''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'', const [[../BasicDataTypes|bool]] ''_bActive'' = true)
 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateTask''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'', const [[../BasicDataTypes|bool]] ''_bActive'' = true)
 
|-
 
|-
Line 41: Line 41:
 
| style = 'color: #505050; line-height: 0.5;' |''activate or deactivate the given task''
 
| style = 'color: #505050; line-height: 0.5;' |''activate or deactivate the given task''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|EQuestState]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#EQuestState|EQuestState]]  
 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetTaskState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'') const
 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetTaskState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'') const
 
|-
 
|-
Line 47: Line 47:
 
| style = 'color: #505050; line-height: 0.5;' |''get current state of the given task''
 
| style = 'color: #505050; line-height: 0.5;' |''get current state of the given task''
 
|-
 
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|EQuestState]]  
+
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTaskState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'', const [[../BasicDataTypes|EQuestState]] ''_State'')
+
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTaskState''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'', const [[../LogicEnums#EQuestState|EQuestState]] ''_State'')
 
|-
 
|-
 
|
 
|
 
| style = 'color: #505050; line-height: 0.5;' |''set the state of the given task''
 
| style = 'color: #505050; line-height: 0.5;' |''set the state of the given task''
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''NotifyQuestUpdate''' (const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'')
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 1.0;' |''notify the user that the state of the given quest task has changed even though its logical state hasn't changed (NOTE: This will do nothing if the quest/task is not currently active)''
 +
|-
 
|}
 
|}

Latest revision as of 10:51, 20 October 2017

class QuestJournal

Provides an interface to interact with the player's quest journal, access quest states, etc.

Class Methods

bool IsQuestActive (const string&in _sQuestName) const
is the given quest currently active (i.e. in the player's journal)
void ActivateQuest (const string&in _sQuestName, const bool _bActive = true)
activate or deactivate the given quest (start/cancel the quest)
EQuestState GetQuestState (const string&in _sQuestName) const
get current state of the given quest
void SetQuestState (const string&in _sQuestName, const EQuestState _State)
set the state of the given quest
bool IsTaskActive (const string&in _sQuestName, const string&in _sTaskName) const
is the given task currently active?
void ActivateTask (const string&in _sQuestName, const string&in _sTaskName, const bool _bActive = true)
activate or deactivate the given task
EQuestState GetTaskState (const string&in _sQuestName, const string&in _sTaskName) const
get current state of the given task
void SetTaskState (const string&in _sQuestName, const string&in _sTaskName, const EQuestState _State)
set the state of the given task
void NotifyQuestUpdate (const string&in _sQuestName, const string&in _sTaskName)
notify the user that the state of the given quest task has changed even though its logical state hasn't changed (NOTE: This will do nothing if the quest/task is not currently active)

class QuestJournal

Provides an interface to interact with the player's quest journal, access quest states, etc.

Class Methods

bool IsQuestActive (const string&in _sQuestName) const
is the given quest currently active (i.e. in the player's journal)
bool ActivateQuest (const string&in _sQuestName, const bool _bActive = true)
activate or deactivate the given quest (start/cancel the quest)
EQuestState GetQuestState (const string&in _sQuestName) const
get current state of the given quest
EQuestState SetQuestState (const string&in _sQuestName, const EQuestState _State)
set the state of the given quest
bool IsTaskActive (const string&in _sQuestName, const string&in _sTaskName) const
is the given task currently active?
bool ActivateTask (const string&in _sQuestName, const string&in _sTaskName, const bool _bActive = true)
activate or deactivate the given task
EQuestState GetTaskState (const string&in _sQuestName, const string&in _sTaskName) const
get current state of the given task
EQuestState SetTaskState (const string&in _sQuestName, const string&in _sTaskName, const EQuestState _State)
set the state of the given task