ForceRefTo - ReferenceAlias

Member of: ReferenceAlias Script

Forces this alias to use the specified reference.

Syntax

Function ForceRefTo(ObjectReference akNewRef) native

Parameters

• akNewRef: The ObjectReference to tell this alias to use

Return Value

None.

Examples

; Force the alias to use us as the reference (if script extends ObjectReference)
Alias_JohnDoe.ForceRefTo(self)

Notes

• Use of this function causes this actor (and all other actors in any current running scene in the quest) to re-evaluate their packages. Calling this multiple times in a row can result in actors in running scenes to lose their scene package permanently and result in brokenness. Do not call this multiple times in a row while a scene is running in the quest whose alias you are forcing to.
• This function does not allow you to clear an alias by forcing it to None. Instead, use the Clear function.
• ForceRefTo() does not yield and wait for the alias's reference to reflect the that of the new forced value
• Calling this function means the reference will be forced rapidly, not immediately
• Repeated calls to the same alias, even with different objectreference criteria will execute in call order(approximate), one after another.
• Can still fail under certain conditions, though it does appear to bypass many if not most CK fill conditions
• See discussion for state assurance examples

See Also

• ReferenceAlias Script
• Clear - ReferenceAlias
• GetReference - ReferenceAlias
• ForceLocationTo