Quest Script
Revision as of 22:14, 25 October 2013 by imported>CraftySentinel (→SKSE Functions: Missing ')
Extends: Form Script
Script for the manipulation of quests.
Definition
ScriptName Quest extends FormMember Functions
| Function | Description |
|---|---|
| CompleteAllObjectives() | Completes all a quests objectives. |
| CompleteQuest() | Flags this quest as completed. |
| FailAllObjectives() | Flags all quest objects as failed. |
| Alias GetAlias(Int aiAliasID) | Obtains the Alias attached to this quest associated with the specified ID. |
| Int GetCurrentStageID() | Obtains the highest completed stage on this quest. |
| Int GetCurrentStageID() | Alias for GetCurrentStageID(). |
| Bool IsStageDone(Int aiStage) | Alias for IsStageDone(). |
| Bool IsActive() | Is this quest "active"? (Tracked by the player). |
| Bool IsCompleted() | Returns whether this quest is completed or not. |
| Bool IsObjectiveCompleted(Int aiObjective) | Obtains whether the specified objective is completed or not. |
| Bool IsObjectiveDisplayed(Int aiObjective) | Obtains whether the specified objective is displayed or not. |
| Bool IsObjectiveFailed(Int aiObjective) | Obtains whether the specified objective is failed or not. |
| Bool IsRunning() | Returns whether this quest is currently running or not. |
| Bool IsStageDone(Int aiStage) | Checks to see if the specified stage is done or not. |
| Bool IsStarting() | Returns whether this quest is currently enabled but not running yet. |
| Bool IsStopping-() | Returns whether this quest is currently not enabled anymore but still shutting down. |
| Bool IsStopped-() | Returns whether this quest is currently fully stopped. |
| Bool ModObjectiveGlobal(Float afModValue, GlobalVariable aModGlobal, Int aiObjectiveID, Float afTargetValue, Bool abCountingUp, Bool abCompleteObjective, Bool abRedisplayObjective) | Mods a global variable in a threadsafe way. Optional parameters allow automatic redisplay and completion (or failure) of a quest objective using this global variable. |
| Reset() | Resets this quest. |
| SetActive(Bool abActive) | Sets or clears this quest as "active". (Tracked by the player) |
| Bool SetCurrentStageID(Int aiStageID) | Sets the quest to the requested stage, returning true if it succeeded. |
| SetObjectiveCompleted(Int aiObjective, Bool abCompleted) | Sets whether the specified objective is completed or not. |
| SetObjectiveDisplayed(Int aiObjective, Bool abDisplayed) | Sets whether the specified objective is displayed or not. |
| SetObjectiveFailed(Int aiObjective, Bool abFailed) | Sets whether the specified objective is failed or not. |
| Bool SetCurrentStageID(Int aiStage) | Alias of SetCurrentStageID(). |
| Bool Start() | Starts this quest. |
| Stop() | Stops the quest. |
| Bool UpdateCurrentInstanceGlobal(GlobalVariable aUpdateGlobal) | Updates the value for the given global for the quest's current instance. |
SKSE Global Functions
| Function | Description |
|---|---|
| Quest GetQuest(String editorID) | Returns the Quest with the specified editor id. |
SKSE Functions
| Function | Description |
|---|---|
| String GetID() | Returns the editor ID of the Quest. |
| Int GetPriority() | Returns the priority of the Quest. |
| Int GetNumAliases() | Returns the number of aliases associated with the Quest. |
| Alias GetNthAlias(Int index) | Returns the specified alias associated with the Quest. |
| Alias GetAliasByName(String name) | Returns the editor ID of the quest. |