Difference between revisions of "TryToRemoveFromFaction - ReferenceAlias"
Jump to navigation
Jump to search
imported>Jlundin (Created page with "Category:Scripting Category:Papyrus '''Member of:''' ReferenceAlias Script This is a convenient way to remove an actor in an alias from a faction without calling [[G...") |
imported>Thingy Person (→Syntax) |
||
Line 8: | Line 8: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
bool Function TryToRemoveFromFaction(Faction FactionToRemoveFrom) | bool Function TryToRemoveFromFaction(Faction FactionToRemoveFrom) | ||
Actor ActorRef = GetActorReference() | |||
if ActorRef | |||
ActorRef.RemoveFromFaction(FactionToRemoveFrom) | |||
Return True | |||
EndIf | |||
Return False | |||
EndFunction | |||
</source> | </source> | ||
Latest revision as of 16:22, 29 June 2013
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)