OnPlayerSleepStop - ScriptObject

From Creation Kit
Jump to: navigation, search

Member of: ScriptObject

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.

Syntax

Event OnPlayerSleepStop(bool abInterrupted, ObjectReference akBed)

Parameters

  • abInterrupted: Whether sleep was interrupted or not.
  • akBed: The bed the player activated.

Example

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
endEvent

Notes

  • Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

See Also