Difference between revisions of "RegisterForMenuOpenCloseEvent - ScriptObject"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added menus cheat sheet) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[ScriptObject Script|ScriptObject]] | '''Member of:''' [[ScriptObject Script|ScriptObject]] | ||
| Line 14: | Line 11: | ||
== Parameters == | == Parameters == | ||
*asMenuName: | *asMenuName: The name of the menu which is opening or closing. See also [[Menus]]. | ||
== Return Value == | == Return Value == | ||
| Line 24: | Line 21: | ||
RegisterForMenuOpenCloseEvent("LockpickingMenu") | RegisterForMenuOpenCloseEvent("LockpickingMenu") | ||
</source> | </source> | ||
== Menus == | |||
{{Template:Menus}} | |||
== Notes == | == Notes == | ||
| Line 32: | Line 32: | ||
*[[UnregisterForMenuOpenCloseEvent - ScriptObject]] | *[[UnregisterForMenuOpenCloseEvent - ScriptObject]] | ||
*[[OnMenuOpenCloseEvent - ScriptObject]] | *[[OnMenuOpenCloseEvent - ScriptObject]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Non-Delayed Native Functions]] | |||
[[Category:User Interface]] | |||
Latest revision as of 19:37, 11 February 2018
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[edit | edit source]
Function RegisterForMenuOpenCloseEvent(string asMenuName) nativeParameters[edit | edit source]
- asMenuName: The name of the menu which is opening or closing. See also Menus.
Return Value[edit | edit source]
None
Examples[edit | edit source]
; Register for when the Lockpicking menu open/close are updated
RegisterForMenuOpenCloseEvent("LockpickingMenu")Menus[edit | edit source]
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[edit | edit source]
Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.