ForceRefIfEmpty - ReferenceAlias

Member of: ReferenceAlias Script

Forces this alias to use the specified reference, but only if the alias is currently empty

Syntax

bool Function ForceRefIfEmpty(ObjectReference akNewRef)
	if (GetReference())
		return False
	else
		ForceRefTo(akNewRef)
		return True
	endif
EndFunction

Parameters

• akNewRef: The ObjectReference to tell this alias to use, if empty

Return Value

True if the alias now holds the passed reference, false if it was already filled.

Examples

; Force the alias to use the random person as the reference, but only if the alias is currently empty
Alias_JohnDoe.ForceRefIfEmpty(RandomPerson)

Notes:

Return value is NOT a true reflection of (AliasReference == ExpectedForcedResult)

• It IS a reflection that the alias met the criteria to have ForceRefTo() called on it
• ForceRefTo does not yield and wait for the alias's reference to reflect the that of the new forced value
• ForceRefTo may be queued or in progress by the time this function returns true.
• False means cannot be filled, alias is already occupied

See Also

• ReferenceAlias Script
• ForceRefTo - ReferenceAlias