Difference between revisions of "UnregisterForTutorialEvent - ScriptObject"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added category) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[ScriptObject Script|ScriptObject]] | '''Member of:''' [[ScriptObject Script|ScriptObject]] | ||
Unregisters this script from receiving [[OnTutorialEvent - ScriptObject|OnTutorialEvent]]. | Unregisters this script from receiving [[OnTutorialEvent - ScriptObject|OnTutorialEvent]]. | ||
Only the script that unregisters for an event will stop receiving it. Other scripts will still receive the event if they registered for it | Only the script that unregisters for an event will stop receiving it. | ||
Other scripts will still receive the event if they registered for it separately. | |||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Function UnregisterForTutorialEvent( | Function UnregisterForTutorialEvent(string asEventName) Native | ||
</source> | </source> | ||
== Parameters == | == Parameters == | ||
asEventName | *asEventName: The name of the tutorial event to unregister for. See [[OnTutorialEvent - ScriptObject|OnTutorialEvent]] for event names. | ||
== Return Value == | == Return Value == | ||
| Line 26: | Line 24: | ||
== Notes == | == Notes == | ||
None | |||
== See Also == | == See Also == | ||
| Line 32: | Line 30: | ||
*[[RegisterForTutorialEvent - ScriptObject]] | *[[RegisterForTutorialEvent - ScriptObject]] | ||
*[[OnTutorialEvent - ScriptObject]] | *[[OnTutorialEvent - ScriptObject]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Non-Delayed Native Functions]] | |||
[[Category:User Interface]] | |||
Latest revision as of 21:06, 11 February 2018
Member of: ScriptObject
Unregisters this script from receiving OnTutorialEvent.
Only the script that unregisters for an event will stop receiving it. Other scripts will still receive the event if they registered for it separately.
Syntax[edit | edit source]
Function UnregisterForTutorialEvent(string asEventName) NativeParameters[edit | edit source]
- asEventName: The name of the tutorial event to unregister for. See OnTutorialEvent for event names.
Return Value[edit | edit source]
None
Examples[edit | edit source]
; Unregister for tutorial-related events.
UnregisterForTutorialEvent("HackingEntered")Notes[edit | edit source]
None