TryToRemoveFromFaction - ReferenceAlias

From the CreationKit Wiki
Revision as of 16:22, 29 June 2013 by imported>Thingy Person (→‎Syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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[edit | edit source]

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

Parameters[edit | edit source]

  • FactionToRemoveFrom: The faction to remove the actor from

Return Value[edit | edit source]

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

Examples[edit | edit source]

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

See Also[edit | edit source]