Difference between revisions of "Quest Script"

*Function [[CompleteAllObjectives - Quest|CompleteAllObjectives]]()

**Completes all a quests objectives.

*Function [[CompleteQuest - Quest|CompleteQuest]]()

**Flags this quest as completed.

*Function [[FailAllObjectives - Quest|FailAllObjectives]]()

**Flags all quest objects as failed.

*Alias Function [[GetAlias - Quest|GetAlias]](int aiAliasID)

**Obtains the [[Alias Script|Alias]] attached to this quest associated with the specified ID.

*int Function [[GetCurrentStageID - Quest|GetCurrentStageID]]()

**Obtains the highest completed stage on this quest.

*int Function [[GetCurrentStageID - Quest|GetStage]]()

**Alias for GetCurrentStageID().

*bool Function [[IsStageDone - Quest|GetStageDone]](int aiStage)

**Alias for IsStageDone().

*bool Function [[IsActive - Quest|IsActive]]()

**Is this quest "active"? (Tracked by the player).

*bool Function [[IsCompleted - Quest|IsCompleted]]()

**Returns whether this quest is completed or not.

*bool Function [[IsObjectiveCompleted - Quest|IsObjectiveCompleted]](int aiObjective)

**Obtains whether the specified objective is completed or not.

*bool Function [[IsObjectiveDisplayed - Quest|IsObjectiveDisplayed]](int aiObjective)

**Obtains whether the specified objective is displayed or not.

*bool Function [[IsObjectiveFailed - Quest|IsObjectiveFailed]](int aiObjective)

**Obtains whether the specified objective is failed or not.

*bool Function [[IsRunning - Quest|IsRunning]]()

**Returns whether this quest is currently running or not.

*bool Function [[IsStageDone - Quest|IsStageDone]](int aiStage)

**Checks to see if the specified stage is done or not.

*bool Function [[IsStarting - Quest|IsStarting]]()

**Returns whether this quest is currently enabled but not running yet.

*bool Function [[IsStopping- Quest|IsStopping]]()

**Returns whether this quest is currently not enabled anymore but still shutting down.

*bool Function [[IsStopped- Quest|IsStopped]]()

**Returns whether this quest is currently fully stopped.

*bool Function [[ModObjectiveGlobal - Quest|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.

*Function [[Reset - Quest|Reset]]()

**Resets this quest.

*Function [[SetActive - Quest|SetActive]](bool abActive)

**Sets or clears this quest as "active". (Tracked by the player)

*bool Function [[SetCurrentStageID - Quest|SetCurrentStageID]](int aiStageID)

**Sets the quest to the requested stage, returning true if it succeeded.

*Function [[SetObjectiveCompleted - Quest|SetObjectiveCompleted]](int aiObjective, bool abCompleted)

**Sets whether the specified objective is completed or not.

*Function [[SetObjectiveDisplayed - Quest|SetObjectiveDisplayed]](int aiObjective, bool abDisplayed)

**Sets whether the specified objective is displayed or not.

*Function [[SetObjectiveFailed - Quest|SetObjectiveFailed]](int aiObjective, bool abFailed)

**Sets whether the specified objective is failed or not.

*bool Function [[SetCurrentStageID - Quest|SetStage]](int aiStage)

**Alias of SetCurrentStageID().

*bool Function [[Start - Quest|Start]]()

**Starts this quest.

*Function [[Stop - Quest|Stop]]()

**Stops the quest.

*bool Function [[UpdateCurrentInstanceGlobal - Quest|UpdateCurrentInstanceGlobal]](GlobalVariable aUpdateGlobal)

**Updates the value for the given global for the quest's current instance.