Difference between revisions of "AddToFaction"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Kkuhlmann
 
imported>Ez0n3
m
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=='''Description'''==
{{Function
 
|origin = GECK1
'''[[AddToFaction]]''' Adds an actor (only the reference not the base object) into a faction. It is called on the Reference and has two parameters: the faction, and the faction rank.
|summary = Adds an actor (only the reference not the base object) into a faction. It is called on the Reference and has two parameters: the faction, and the faction rank.
 
|name = AddToFaction
=='''Syntax'''==
|returnType = void
 
  |referenceType = [ActorRefID]
  [''ActorREF''.]AddToFaction ''Faction'' ''FactionRank''
|arguments =
 
  {{FunctionArgument
=='''Examples'''==
  |Name = FactionID
 
  |Type = ref
  BuddyRef.AddToFaction AntFaction 1
  }}{{FunctionArgument
  |Name = FactionRank
  |Type = int
  }}
  |example = BuddyRef.AddToFaction AntFaction 1
BuddyRef is now in the AntFaction at rank 1, but not all Buddy base objects are in the AntFaction.
BuddyRef is now in the AntFaction at rank 1, but not all Buddy base objects are in the AntFaction.
}}


=='''Notes'''==
==Notes==
*This duplicates the functionality of [[SetFactionRank]].
*This does not work the same as [[SetFactionRank]], which is called on the base form.
 
*This function is new in the GECK, and was not available in the TES4 Construction Set.
 
=='''See Also'''==
[[RemoveFromFaction]]


=='''Reference'''==
==See Also==
None provided.
*[[RemoveFromFaction]]
<!-- [[AddToFaction_Reference|List of functions that use AddToFaction]] (wiki) -->


[[Category:Functions]]
[[Category:Functions]]
[[Category:Functions (GECK 1.1)]]
[[Category:Faction Functions]]
[[Category:Faction Functions]]
[[Category:Faction Functions (GECK 1.1)]]

Latest revision as of 05:07, 15 January 2011

< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Description

Adds an actor (only the reference not the base object) into a faction. It is called on the Reference and has two parameters: the faction, and the faction rank.

Syntax

[help]
[ActorRefID].AddToFaction FactionID:ref FactionRank:int

Example

BuddyRef.AddToFaction AntFaction 1

BuddyRef is now in the AntFaction at rank 1, but not all Buddy base objects are in the AntFaction.

Notes

  • This does not work the same as SetFactionRank, which is called on the base form.
  • This function is new in the GECK, and was not available in the TES4 Construction Set.

See Also