IsStageDone - Quest

From the CreationKit Wiki
Revision as of 18:25, 8 September 2023 by Jadkai (talk | contribs) (Elaborate on notes. Add that GetStageDone is an alias. Indicate what happens when called from the current stage's quest fragment script. Indicate what happens if you call SetStage on a lower stage.)
Jump to navigation Jump to search

Member of: Quest Script

Obtains whether the specified quest stage is done or not.

A stage is "done" if it has ever been visited with the SetCurrentStageID or SetStage functions.

GetStageDone is an alias for IsStageDone.

Syntax

bool Function IsStageDone(int aiStage) native
bool Function GetStageDone(int aiStage)
  return IsStageDone(aiStage)
EndFunction

Parameters

  • aiStage: The stage to check.

Return Value

Whether the passed-in stage is done or not.

Examples

; is stage 20 done in the main quest?
bool mainQuestStage20Done = MainQuestProperty.IsStageDone(20)


; Prints a debug message if the side quest has completed stage 10
if (SideQuestProperty.GetStageDone(10))
  Debug.Trace("The side quest has finished stage 10!")
endIf

Notes

  • IsStageDone returns true for the current quest stage, even while the quest fragment scripts for the current stage have not yet completed.
  • Assume you have a quest with stages 0, 10, 20, 30, 40, 50, and 60. You call SetStage for stages 0, 40, 20, and 60, in that order. See the following table for the result that IsStageDone will return after the final SetStage (to stage 60) has been completed:
IsStageDone Result
0 true
10 false
20 true
30 false
40 true
50 false
60 true

Even though GetCurrentStageID() will return 60, IsStageDone will return false for stages 10, 30, and 50, because these stages have not yet been visited. If you subsequently call SetStage(30), the result of GetCurrentStageID will still be 60, but IsStageDone(30) will now return true.

See Also

Retrieved from "https://ck.uesp.net/w/index.php?title=IsStageDone_-_Quest&oldid=23274"