Difference between revisions of "GetSleepState - Actor"
Jump to navigation
Jump to search
imported>Catwheezle (Changed return value ordering to match GetSleeping. Added "see also" section.) |
imported>Catwheezle m (Link fix.) |
||
| Line 31: | Line 31: | ||
== 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. | ||
== See Also == | == See Also == | ||
*[[Actor Script]] | *[[Actor Script]] | ||
*[[GetSleeping | *[[GetSleeping]] | ||
*[[IsPCSleeping]] | *[[IsPCSleeping]] | ||
Revision as of 18:46, 14 February 2012
Member of: Actor Script
Gets this actor's sleep state.
Syntax
int Function GetSleepState() nativeParameters
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!")
endIfNotes
- 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.