Difference between revisions of "AddToFaction"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Talkie Toaster
m
imported>DewiMorgan
m (→‎Notes: +note it's not in the TES4 wiki; debolding titles)
Line 1: Line 1:
=='''Description'''==
==Description==


'''[[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.
'''[[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.


=='''Syntax'''==
==Syntax==


  [''ActorREF''.]AddToFaction ''Faction'' ''FactionRank''
  [''ActorREF''.]AddToFaction ''Faction'' ''FactionRank''


=='''Examples'''==
==Examples==


  BuddyRef.AddToFaction AntFaction 1
  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 does not work the same as [[SetFactionRank]], which is called on the base form.
*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==
=='''See Also'''==
[[RemoveFromFaction]]
[[RemoveFromFaction]]


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

Revision as of 12:41, 13 April 2009

Description

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.

Syntax

[ActorREF.]AddToFaction Faction FactionRank

Examples

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

RemoveFromFaction

Reference

None provided.