OnSleepStop - Form

From Creation Kit
Jump to: navigation, search

Member of: ActiveMagicEffect Script, Alias Script, and Form Script

Event called when the player wakes up - if this active magic effect/alias/form is registered for it.

Syntax

Event OnSleepStop(bool abInterrupted)

Parameters

  • abInterrupted: Whether sleep was interrupted or not.

Example

Function SomeFunction()
  RegisterForSleep() ; Before we can use OnSleepStart we must register.
EndFunction
 
Event OnSleepStop(bool abInterrupted)
	if abInterrupted
	    Debug.Trace("Player was woken by something!")
	else
	    Debug.Trace("Player woke up naturally")
	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.
  • This event is not relayed to any aliases or magic effects attached to the form.

See Also