UnregisterForMenuOpenCloseEvent function - ScriptObject script

Found in:

Vanilla

voidfunctionUnregisterForMenuOpenCloseEvent(stringasMenuName)Native

Description

Wiki Description

Unregisters this active magic effect/alias/form from receiving menu open/close events.

Only the script that unregisters for an event will stop receiving it. Other scripts attached to the same form, alias, or magic effect will still receive the event if they registered for it seperately.

Documentation Comment

Unregister for the specified menu open/close event

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

; Unregister for Lockpicking menu open/close events - we don't want them anymore
UnregisterForMenuOpenCloseEvent("LockpickingMenu")

Auto-Generated Example

string myString__asMenuName

myScriptObject__toCallFunctionOn.UnregisterForMenuOpenCloseEvent(myString__asMenuName)

Additional References

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