Quest

Found in:

Vanilla

Inheritance Tree

No indexed scripts extend this script.

Structs

Properties

Events

Functions

Found in:

Vanilla

boolfunctionModObjectiveGlobal(floatafModValue, GlobalVariableaModGlobal, intaiObjectiveID=-1, floatafTargetValue=-1, boolabCountingUp=true, boolabCompleteObjective=true, boolabRedisplayObjective=true, boolabAllowRollbackObjective=false)

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.

Found in:

Vanilla

voidfunctionSetAllStages(intlastStage)

kmk- for testing - sets all stages up to lastStage

Found in:

Vanilla

voidfunctionSetQuestStage(Quest:QuestStagequestStageToSet)Global

Sets the quest stage on the specified quest.

Found in:

Vanilla

boolfunctionGetQuestStageDone(Quest:QuestStagequestStageToCheck)Global

Returns whether the specified quest stage is set.

Found in:

Vanilla

voidfunctionSetObjectiveSkipped(intaiObjectiveID)

Sets the specified objective as skipped (hidden in this case, if it wasn't completed)

Found in:

Vanilla

voidfunctionSetObjectiveActive(intaiObjective, boolabForceRedisplay=true)

jduvall - convenience function - uncompletes, unfails and displays the objective

Found in:

Vanilla

voidfunctionCompleteAllObjectives()Native

Flags all objectives on this quest as complete.

Found in:

Vanilla

voidfunctionCompleteQuest()Native

Flags this quest as completed.

Found in:

Vanilla

voidfunctionFailAllObjectives()Native

Flags all objectives on this quest as failed.

Found in:

Vanilla

AliasfunctionGetAlias(intaiAliasID)Native

Obtains the alias with the specified ID that is attached to this quest.

Found in:

Vanilla

intfunctionGetCurrentStageID()Native

Obtains the highest completed stage in this Quest.

Found in:

Vanilla

ObjectReference[]functionGetCurrentStageTargets()Native

Returns the array of object reference targets pertinent to the current quest stage

Found in:

Vanilla

intfunctionGetStage()

Obtains the highest completed stage in this Quest.

Found in:

Vanilla

floatfunctionGetQuestTimeRemaining()Native

gets the remaining time for the quest timer if any

Found in:

Vanilla

boolfunctionGetStageDone(intaiStage)

Obtains whether the specified stage is done or not.

Found in:

Vanilla

boolfunctionHasObjective(intaiObjective)Native

Returns whether or not the quest has the given objective.

Found in:

Vanilla

boolfunctionIsActive()Native

Checks to see if this quest is active (currently tracked by the player).

Found in:

Vanilla

boolfunctionIsCompleted()Native

Checks to see if this quest is completed.

Found in:

Vanilla

boolfunctionIsObjectiveCompleted(intaiObjective)Native

Obtains whether the specified quest objective is completed or not.

Found in:

Vanilla

boolfunctionIsObjectiveDisplayed(intaiObjective)Native

Obtains whether the specified quest objective is displayed or not.

Found in:

Vanilla

boolfunctionIsObjectiveFailed(intaiObjective)Native

Obtains whether the specified quest objective is failed or not.

Found in:

Vanilla

voidfunctionSetObjectiveDisplayedAtTop(intaiObjective)Native

Sets the specified objective to be displayed at the top of the player's objective list

Found in:

Vanilla

boolfunctionIsQuestTimerPaused()Native

Checks if the quest timer is paused; returns true if paused otherwise false which means the timer is running

Found in:

Vanilla

boolfunctionIsRunning()Native

Checks to see if this quest is running or not.

Found in:

Vanilla

boolfunctionIsStageDone(intaiStage)Native

Obtains whether the specified stage is done or not.

Found in:

Vanilla

boolfunctionIsStarting()Native

Checks to see if this quest is in the process of starting up.

Found in:

Vanilla

boolfunctionIsStopping()Native

Checks to see if this quest is in the process of shutting down.

Found in:

Vanilla

boolfunctionIsStopped()Native

Checks to see if this quest is completely stopped.

Found in:

Vanilla

voidfunctionModQuestTimer(floatafModValue)Native

Modifies a quest timer
The timer is modified by the given afModValue can be negative or positive but not 0

Found in:

Vanilla

voidfunctionPauseQuestTimer(boolabPause=true)Native

Pauses the quest timer if abPause is true, resumes it if false. If the timer was already in the requested state nothing happens.

Found in:

Vanilla

voidfunctionRemoveRequestedPCMQuestLocations()Native

Removes PCM locations requested by this quest.

Found in:

Vanilla

voidfunctionReset()Native

Resets this quest.

Found in:

Vanilla

voidfunctionSetActive(boolabActive=true)Native

Flags this quest as active or not (tracked by the player).

Found in:

Vanilla

boolfunctionSetCurrentStageID(intaiStageID)Native

Attempts to set the quest's current stage. If the stage exists, and was successfully set, the function returns true. Otherwise, the function returns false and the stage is unchanged. Is latent and will wait for the quest to start if it has to start the quest. If the stage has any fragments attached to it, the function will also wait for those fragments to finish running before returning.

Found in:

Vanilla

voidfunctionSetObjectiveCompleted(intaiObjective, boolabCompleted=true)Native

Sets whether the specified quest objective is completed or not.

Found in:

Vanilla

voidfunctionSetObjectiveDisplayed(intaiObjective, boolabDisplayed=true, boolabForce=false)Native

Sets whether the specified quest objective is displayed or not.

Found in:

Vanilla

voidfunctionSetObjectiveFailed(intaiObjective, boolabFailed=true)Native

Sets whether the specified quest objective is failed or not.

Found in:

Vanilla

voidfunctionSetObjectiveFailedIfNotCompleted(intaiObjective)

jduvall - convenience function
fails the objective if it's not completed

Found in:

Vanilla

boolfunctionSetStage(intaiStage)

Found in:

Vanilla

voidfunctionSetStageNoWait(intaiStage)Native

Sets the quest to the requested stage. Will NOT wait for the quest to start up, or for fragments to run. As such, it cannot return whether
the stage was set or not, unlike SetStage or SetCurrentStageID

Found in:

Vanilla

boolfunctionStart()Native

Starts this quest. Is latent and will not return until the quest is actually started (and any start-up stage fragments run).

Found in:

Vanilla

boolfunctionStartNoWait()Native

Starts the quest - returns whether the quest was able to be started or not
This function does not wait for aliases to fill or fragments to run and returns immediately

Found in:

Vanilla

voidfunctionStartQuestTimer(floatafTimeInHours=-1)Native

Starts this quests timer with the given time or the time saved on the quest itself if none was given.
Will reset the timer with the new time if the timer was running.

Found in:

Vanilla

voidfunctionStop()Native

Stops the quest.

Found in:

Vanilla

voidfunctionStopQuestTimer()Native

stop the running quest timer
Will trigger OnQuestTimerEnd

Found in:

Vanilla

boolfunctionUpdateCurrentInstanceGlobal(GlobalVariableaUpdateGlobal)Native

Attempts to update the stored value of the given global in the instance data for the quest's current instance. The function only returns false on failure which can be caused by calling the function when there is no active instance on the quest or by passing a global not in the quest's text global list.