OnMenuOpenCloseEvent - ScriptObject
Revision as of 19:31, 11 February 2018 by imported>Qazaaq (added menus cheat sheet)
Member of: ScriptObject
Event called when menus are opened or closed - if this active magic effect/alias/form is registered for it.
This event will only be sent to the specific script that registered for it. Other scripts attached to the same form/alias/active magic effect will not receive the event unless they also register.
Syntax
Event OnMenuOpenCloseEvent(string asMenuName, bool abOpening)Parameters
- asMenuName: Name of the menu opening / closing. E.g. "LockpickingMenu", "ContainerMenu", etc.
- abOpening: True if the menu is opening, false if the menu is closing
Example
Function SomeFunction()
RegisterForMenuOpenCloseEvent("LockpickingMenu") ; Before we can use OnMenuOpenCloseEvent we must register.
EndFunction
Event OnMenuOpenCloseEvent(string asMenuName, bool abOpening)
if (asMenuName== "LockpickingMenu")
if (abOpening)
Debug.Trace("Lockpicking menu is open!")
endif
endif
endEventMenus
These are the User Interface menus that Players interact with in game.
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.