RegisterForSleep - Form

From Creation Kit
Jump to: navigation, 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

Function RegisterForSleep() native

Parameters

None

Return Value

None

Examples

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

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