GetOpenState - ObjectReference

Revision as of 14:13, 6 February 2021 by imported>Scrivener07
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ObjectReference Script

Obtains this object's current "open state".

SyntaxEdit

int Function GetOpenState() native

ParametersEdit

None

Return ValueEdit

The current "open state" of the object. Will be one of the following:

  • 0: None (object can't be opened or closed)
  • 1: Open
  • 2: Opening
  • 3: Closed
  • 4: Closing

ExamplesEdit

; Is this door open or opening?
int openState = JailDoor.GetOpenState()
if (openState == 1 || openState == 2) ; Open or opening
  Debug.Trace("Door is open!")
endIf

NotesEdit

  • Can also be used to check the operational status of a generator(if it's turning on or turning off.).

See AlsoEdit