GetOpenState - ObjectReference

Member of: ObjectReference Script

Obtains this object's current "open state".

Syntax

int Function GetOpenState() native

Parameters

None

Return Value

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

Examples

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

Notes

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

See Also

• ObjectReference Script
• SetOpen - ObjectReference