RegisterForMenuOpenCloseEvent function - ScriptObject script

Found in:

Vanilla

voidfunctionRegisterForMenuOpenCloseEvent(stringasMenuName)Native

Description

Wiki Description

Registers this active magic effect/alias/form to receive menu open/close events.

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 alias to receive events when menus are opened / closed

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.

Parameters

stringasMenuName
CK Wiki Description
The name of the menu which is opening or closing. See also Menus.

Examples

; Register for when the Lockpicking menu open/close are updated
RegisterForMenuOpenCloseEvent("LockpickingMenu")

Auto-Generated Example

string myString__asMenuName

myScriptObject__toCallFunctionOn.RegisterForMenuOpenCloseEvent(myString__asMenuName)

Additional References

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