Difference between revisions of "Clear - ReferenceAlias"
Jump to navigation
Jump to search
imported>DayDreamer m (Add Note, match Clear - LocationAlias) |
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.) |
||
(One intermediate revision by one other user not shown) | |||
Line 24: | Line 24: | ||
== Notes == | == 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. | *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 == |
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.