Difference between revisions of "GetFactions - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>TidalWraith
m (Modified Example)
imported>TidalWraith
m (Edited Description and Parameters to hopefully make more sense)
Line 4: Line 4:
   
   


Returns all factions of the actor with the specified minimum and maximum ranks (maximum range of -128 to 127)
Returns an array of Factions the Actor is a member of filtered by the Actors rank. (Maximum Range of -128 to 127)
   
   
=== Parameters ===
=== Parameters ===
*minRank: The minimum rank
*minRank: The minimum rank the Actor must be within the faction.


*maxRank: The maximum rank
*maxRank: The maximum rank the Actor can be within the faction.
   
   
=== Return Value ===
=== Return Value ===
A [[Faction Script| Faction]] array is returned containing all factions the actor is a part of within the specified rank range
A [[Faction Script| Faction]] array is returned containing all factions the actor is a part of within the specified rank range.
   
   
== Examples ==
== Examples ==

Revision as of 02:27, 20 June 2015


Faction[] Function GetFactions(int minRank, int maxRank) native


Returns an array of Factions the Actor is a member of filtered by the Actors rank. (Maximum Range of -128 to 127)

Parameters

  • minRank: The minimum rank the Actor must be within the faction.
  • maxRank: The maximum rank the Actor can be within the faction.

Return Value

A Faction array is returned containing all factions the actor is a part of within the specified rank range.

Examples

        ;This example grabs the player, then their factions and finally prints the array of factions to the Papyrus log.
	Actor PlayerRef = Game.GetPlayer()
	Faction[] PlayerFactions = PlayerRef.GetFactions(-128, 127);The maximum range allowed.
	Debug.Trace("Player is a part of the following factions: " + PlayerFactions)

See Also