TryToRemoveFromFaction - ReferenceAlias

Member of: ReferenceAlias Script

This is a convenient way to remove an actor in an alias from a faction without calling GetActorReference() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call RemoveFromFaction() on them without having to test for a reference being present first.

Syntax

bool Function TryToRemoveFromFaction(Faction FactionToRemoveFrom)
	Actor ActorRef = GetActorReference()
	if ActorRef
		ActorRef.RemoveFromFaction(FactionToRemoveFrom)
		Return True
	EndIf
	Return False
EndFunction

Parameters

• FactionToRemoveFrom: The faction to remove the actor from

Return Value

True if actor was removed from the faction, false if there was no actor to remove.

Examples

; Try to remove the boss from the bandit faction
BossAlias.TryToRemoveFromFaction(BanditFaction)

Notes:

(AliasTryFunctions == TRUE) is NOT an accurate reflection of (AliasRef == HasExpectedResults) OR (Alias == HasNewOrNoValue)

• IS a reflection that the alias met the criteria to have the functions called upon them

• Many, if not most of these functions are external dispatch to other scripts and do not wait for expected results
• True means alias had valid reference, and is queued to run your desired function on it, or POSSIBLY already has
• False means the alias does not have a reference, or does not have a reference of the appropriate type
• Try functions do NOT return false if the function called(AddToFaction(), Clear() Etc) go on to fail for any reason

See Also

• ReferenceAlias Script
• TryToAddToFaction - ReferenceAlias
• RemoveFromFaction - Actor