Clear - ReferenceAlias

Member of: ReferenceAlias Script

Clears any reference out of this alias. Will error if this alias is not optional.

Syntax

Function Clear() native

Parameters

None.

Return Value

None.

Examples

; Clear the alias out
Alias_JohnDoe.Clear()

Notes

• 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.

See Also

• ReferenceAlias Script
• GetReference - ReferenceAlias
• ForceRefTo - ReferenceAlias