OnSleepStart - Form

From Creation Kit
Jump to: navigation, search

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

Event called when the player goes to sleep - if this active magic effect/alias/form is registered for it.

Syntax

Event OnSleepStart(float afSleepStartTime, float afDesiredSleepEndTime)

Parameters

  • afSleepStartTime: The time the player went to sleep, in game days passed.
  • afDesiredSleepEndTime: The time the player wants to wake up at, in game days passed.

Example

Function SomeFunction()
  RegisterForSleep() ; Before we can use OnSleepStart we must register.
EndFunction
 
Event OnSleepStart(float afSleepStartTime, float afDesiredSleepEndTime)
	Debug.Trace("Player went to sleep at: " + Utility.GameTimeToString(afSleepStartTime))
	Debug.Trace("Player wants to wake up at: " + Utility.GameTimeToString(afDesiredSleepEndTime))
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