TryToRemoveFromFaction function - ReferenceAlias script

Found in:

Vanilla

boolfunctionTryToRemoveFromFaction(FactionFactionToRemoveFrom)

Description

Wiki Description

This is a convenient way to remove an actor in an alias from a faction without calling ReferenceAlias.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 Actor.RemoveFromFaction(...) on them without having to test for a reference being present first.

Documentation Comment

Convenience function - jduvall

Parameters

FactionFactionToRemoveFrom
CK Wiki Description
The faction to remove the actor from

Examples

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

Auto-Generated Example

Faction myFaction__FactionToRemoveFrom

bool returnedValue = myReferenceAlias__toCallFunctionOn.TryToRemoveFromFaction(myFaction__FactionToRemoveFrom)

ReferenceAlias
ReferenceAlias.TryToAddToFaction(...)
Actor.RemoveFromFaction(...)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki