Difference between revisions of "Script/QuestJournal"
From SF3
| Line 52: | Line 52: | ||
| | | | ||
| 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) |