[dismiss]
This wiki is a copy of the original Skyrim CK wiki created and maintained by the UESP.net. See CreationKit:Copy Notice for more info.
Difference between revisions of "GetSleepState - Actor"
Jump to navigation
Jump to search
imported>Catwheezle (→Notes: add note about use on player.) |
imported>Catwheezle m (→Notes: link fix...) |
||
Line 32: | Line 32: | ||
== Notes == | == 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. | *[[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 [[ | *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 == | == See Also == |
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.