UnregisterForMenuOpenCloseEvent - ScriptObject

Revision as of 20:48, 11 February 2018 by imported>Qazaaq (added menus cheat sheet)

Member of: ScriptObject

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.

Syntax

Function UnregisterForMenuOpenCloseEvent(string asMenuName) native

Parameters

  • asMenuName: The name of the menu which is opening or closing. See also Menus.

Return Value

None

Examples

; Unregister for Lockpicking menu open/close events - we don't want them anymore
UnregisterForMenuOpenCloseEvent("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