RegisterForMenuOpenCloseEvent - ScriptObject

From the Fallout4 CreationKit Wiki
Revision as of 12:27, 3 December 2015 by imported>Plplecuyer
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: ScriptObject

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.

Syntax

Function RegisterForMenuOpenCloseEvent(string asMenuName) native

Parameters

  • asMenuName: Name of the menu opening / closing. E.g. "LockpickingMenu", "ContainerMenu", etc.

Return Value

None

Examples

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

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