RegisterForPlayerSleep - ScriptObject

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search

Member of: ScriptObject

Registers this active magic effect/alias/form to receive events when the player goes to sleep and when he wakes up.

Only the script that registers for an event will receive it. Other scripts attached to the same form, alias, or magic effect will not receive the event unless they also register for it.

Syntax[edit | edit source]

Function RegisterForPlayerSleep() 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
RegisterForPlayerSleep()

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]