Difference between revisions of "GetFactions - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>TidalWraith
m (Edited Description and Parameters to hopefully make more sense)
imported>Bug64
m (standardized the page)
 
Line 1: Line 1:
__NOTOC__
Returns an array of Factions the Actor is a member of filtered by the Actors rank. (Maximum Range of -128 to 127)


== Syntax ==
::<source lang="papyrus">Faction[] Function GetFactions(int minRank, int maxRank) native</source>
::<source lang="papyrus">Faction[] Function GetFactions(int minRank, int maxRank) native</source>
Returns an array of Factions the Actor is a member of filtered by the Actors rank. (Maximum Range of -128 to 127)
   
   
=== Parameters ===
=== Parameters ===

Latest revision as of 12:17, 25 July 2015

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

Syntax[edit | edit source]

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

Parameters[edit | edit source]

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

Return Value[edit | edit source]

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

Examples[edit | edit source]

        ;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[edit | edit source]