eventOnPlayerSleepStop(boolabInterrupted, ObjectReferenceakBed)
Description
Wiki Description
Event called when the player wakes up - if this active magic effect/alias/form is registered for it.
This event will only be sent to the specific script that registered for it. Other scripts attached to the same form/alias/active magic effect will not receive the event unless they also register.
Documentation Comment
Received when the player stops sleeping - whether naturally or interrupted (after registering)
Caveats
CK Wiki - Notes
- Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
Parameters
boolabInterrupted
CK Wiki Description
Whether sleep was interrupted or not.
ObjectReferenceakBed
CK Wiki Description
The bed the player activated.
Examples
Function SomeFunction()
RegisterForPlayerSleep() ; Before we can use OnSleepStart we must register.
EndFunction
Event OnPlayerSleepStop(bool abInterrupted, ObjectReference akBed)
if abInterrupted
Debug.Trace("Player was woken by something while sleeping in " + akBed + "!")
else
Debug.Trace("Player woke up naturally from " + akBed)
endIf
endEventAuto-Generated Example
Scriptname MyCoolScript extends ScriptObject
event OnPlayerSleepStop(bool abInterrupted, ObjectReference akBed)
Debug.trace("Event received - OnPlayerSleepStop: abInterrupted = " + abInterrupted + " akBed = " + akBed)
endEvent