RegisterForSleep - Form

From the CreationKit Wiki
Jump to navigation Jump to search

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

Registers this active magic effect/alias/form to receive events when the player goes to sleep and when he wakes up. Only the specific form, alias, or magic effect that registered will get the event - it will not be relayed to attached aliases or magic effects.

Syntax[edit | edit source]

Function RegisterForSleep() native

Parameters[edit | edit source]

None

Return Value[edit | edit source]

None

Examples[edit | edit source]

; Register for when the player goes to sleep and wakes up
RegisterForSleep()

Notes[edit | edit source]

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[edit | edit source]