GetIsResting(object)
Check whether a creature is resting.
int GetIsResting( object oCreature = OBJECT_SELF );
Parameters
oCreature
Creature to be checked. (Default: OBJECT_SELF)
Description
Returns TRUE if oCreature is currently resting. Otherwise, returns FALSE.
Remarks
Note that applying effects such as EffectSleep() or animations such as ANIMATION_LOOPING_SIT_CROSS do not count. Only if a PC has selected his or her "rest" function, or if an NPC has been given the ActionRest() script command will this function return TRUE.
Known Bugs
Prior to 1.28, this function always returned FALSE if called outside of the event OnPlayerRest.
Version
1.28
See Also
functions: | GetLastRestEventType |
categories: | Get Data from Creature Functions |
author: Jason Harris, editor: Charles Feduke
Send comments on this topic.