RegisterForPlayerSleep - ScriptObject | Fallout 4

Found in:

Vanilla
F4SE

voidfunctionRegisterForPlayerSleep()Native

Description

Wiki Description

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.

Documentation Comment

Registers this form to receive events when the player sleeps and wakes up

[DEV SERVER] Loading description...

Caveats

CK Wiki - Notes

Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

Examples

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

Auto-Generated Example

myScriptObject__toCallFunctionOn.RegisterForPlayerSleep()

ScriptObject
UnregisterForPlayerSleep - ScriptObject
OnPlayerSleepStart - ScriptObject
OnPlayerSleepStop - ScriptObject

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Description

Wiki Description

Documentation Comment

Caveats

CK Wiki - Notes

Examples

Auto-Generated Example

Related Pages

Additional References

Description

Wiki Description

Documentation Comment