RegisterForMenuOpenCloseEvent - ScriptObject

From Creation Kit
Jump to: navigation, 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: The name of the menu which is opening or closing. See also Menus.

Return Value

None

Examples

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

Menus

These are the user interface menus that players interact with in game.

Name Description
BarterMenu
BookMenu
Console
ConsoleNativeUIMenu
ContainerMenu
CookingMenu
CreditsMenu
CursorMenu
DialogueMenu
ExamineMenu
FaderMenu
FavoritesMenu
GenericMenu
HUDMenu
LevelUpMenu
LoadingMenu
LockpickingMenu
LooksMenu
MainMenu
MessageBoxMenu
MultiActivateMenu
PauseMenu
PipboyMenu
PromptMenu
ScopeMenu
SitWaitMenu
SleepWaitMenu
SPECIALMenu
TerminalHolotapeMenu
TerminalMenu
VATSMenu
VignetteMenu
WorkshopMenu
Workshop_CaravanMenu

Key

  • Name: The string identifier of the menu.
  • Description: A short description of where or how the menu appears in game.


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