Difference between revisions of "UnregisterForMenuOpenCloseEvent - ScriptObject"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added category) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
'''Member of:''' [[ScriptObject Script|ScriptObject]] | '''Member of:''' [[ScriptObject Script|ScriptObject]] | ||
Line 10: | Line 7: | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Function UnregisterForMenuOpenCloseEvent(string asMenuName) | Function UnregisterForMenuOpenCloseEvent(string asMenuName) Native | ||
</source> | </source> | ||
== 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: | ||
UnregisterForMenuOpenCloseEvent("LockpickingMenu") | UnregisterForMenuOpenCloseEvent("LockpickingMenu") | ||
</source> | </source> | ||
== Menus == | |||
{{Template:Menus}} | |||
== Notes == | == Notes == | ||
Line 30: | Line 30: | ||
== See Also == | == See Also == | ||
*[[ScriptObject Script]] | *[[ScriptObject Script]] | ||
*[[UnregisterForAllMenuOpenCloseEvents - ScriptObject]] | |||
*[[RegisterForMenuOpenCloseEvent - ScriptObject]] | *[[RegisterForMenuOpenCloseEvent - ScriptObject]] | ||
*[[OnMenuOpenCloseEvent - ScriptObject]] | *[[OnMenuOpenCloseEvent - ScriptObject]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Non-Delayed Native Functions]] | |||
[[Category:User Interface]] |
Latest revision as of 21:56, 11 February 2018
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[edit | edit source]
Function UnregisterForMenuOpenCloseEvent(string asMenuName) Native
Parameters[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]
; Unregister for Lockpicking menu open/close events - we don't want them anymore
UnregisterForMenuOpenCloseEvent("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.