GetSleepState - Actor

Member of: Actor Script

Gets this actor's sleep state.

NOTE: This does not work for the player.

Syntax

int Function GetSleepState() native

Parameters

None.

Return Value

The actor's current sleep state.

The following values are returned:

• 4: Sleeping, wants to wake
• 3: Sleeping
• 2: Not sleeping, wants to sleep
• 0: Not sleeping

Examples

; Is the actor sleeping?
if (Sleepy.GetSleepState() == 3)
  Debug.Trace("Sleepy is sleeping!")
endIf

See Also

• Actor Script