Difference between revisions of "Clear - ReferenceAlias"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Wormple12 m (Aliases need to be marked as "optional" if this function is to work. Trying to clear a non-optional alias will throw an error to the log.) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
[[Category:Non-delayed Native Function]] | |||
'''Member of:''' [[ReferenceAlias Script]] | '''Member of:''' [[ReferenceAlias Script]] | ||
Line 21: | Line 22: | ||
Alias_JohnDoe.Clear() | Alias_JohnDoe.Clear() | ||
</source> | </source> | ||
== Notes == | |||
*Use of this function causes this actor (and perhaps other actors in any current running scene in the quest) to re-[[EvaluatePackage - Actor|evaluate]] their packages. When invoked by a script fragment from the current package, this may cause another package and its script fragment to run in parallel. | |||
*Aliases need to be marked as "optional" if this function is to work. Trying to clear a non-optional alias will throw an error to the log. | |||
== See Also == | == See Also == | ||
*[[ReferenceAlias Script]] | *[[ReferenceAlias Script]] | ||
*[[GetReference - ReferenceAlias]] | |||
*[[ForceRefTo - ReferenceAlias]] |
Latest revision as of 15:57, 26 February 2018
Member of: ReferenceAlias Script
Clears any reference out of this alias. Will error if this alias is not optional.
Syntax[edit | edit source]
Function Clear() native
Parameters[edit | edit source]
None.
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; Clear the alias out
Alias_JohnDoe.Clear()
Notes[edit | edit source]
- Use of this function causes this actor (and perhaps other actors in any current running scene in the quest) to re-evaluate their packages. When invoked by a script fragment from the current package, this may cause another package and its script fragment to run in parallel.
- Aliases need to be marked as "optional" if this function is to work. Trying to clear a non-optional alias will throw an error to the log.