Difference between revisions of "GetSleepState - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Catwheezle
m (→‎Notes: link fix...)
imported>Cipscis
(Removed incorrect console/condition categories)
Line 38: Line 38:
*[[GetSleeping]]
*[[GetSleeping]]
*[[IsPCSleeping]]
*[[IsPCSleeping]]
[[Category:Console Commands]]
[[Category:Condition Functions]]

Revision as of 18:49, 14 February 2012

Member of: Actor Script

Gets this actor's sleep state.

Syntax

int Function GetSleepState() native

Parameters

None.

Return Value

The actor's current sleep state.

The following values are returned:

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

Examples

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

Notes

  • GetSleeping also has a return value of 1 when the actor is loading the sleep idle. This return value is not documented for this function.
  • It is undocumented whether this function will work on the player. Exercise caution and update this page with the results of any tests. You may need to use IsPCSleeping instead.

See Also