CheckVar

Prototype: GemRB.CheckVar (VariableName, Context)

Description: Return (and output on terminal) the value of a Game Variable. It executes the CheckVariable gamescript function in the last actor’s context, or, short of that, in the current area’s context. If there is no running game, it terminates the script. GetGameVar(‘variable’) is effectively the same as CheckVar(‘variable’,’GLOBAL’).

Parameters:

  • VariableName - must be shorter than 32 bytes
  • Context - must be exactly 6 bytes long
  • Special cases for Context: LOCALS, GLOBAL, MYAREA

Return value: numeric

See also: GetGameVar


Back to function index, GUIScript introduction.