UpdateCurrentInstanceGlobal - Quest

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: Quest Script

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.

Syntax[edit | edit source]

bool Function UpdateCurrentInstanceGlobal(GlobalVariable aUpdateGlobal) native

Parameters[edit | edit source]

  • aUpdateGlobal: The global on the quest whose cached value should be reset to its current value.

Return Value[edit | edit source]

True, if the global value is successfully updated, false if it is not.

Examples[edit | edit source]

; Sets the side quest stage to 10 - and logs a message if it succeeds
if (!UpdateCurrentInstanceGlobal(GameHour))
  Debug.Trace("Failed to update GameHour value for quest")
endIf

See Also[edit | edit source]