GetOpenState - ObjectReference | Fallout 4

Found in:

Vanilla
F4SE

intfunctionGetOpenState()Native

Description

Wiki Description

Obtains this object's current "open state".

Documentation Comment

Gets the open state of this object. Which can be one of the following:
0 - None
1 - Open
2 - Opening
3 - Closed
4 - Closing

Caveats

CK Wiki - Notes

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

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

Auto-Generated Example

int returnedValue = myObjectReference__toCallFunctionOn.GetOpenState()

ObjectReference
ObjectReference.SetOpen(...)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki