SCR_CampaignFactionManager Interface Reference

Inheritance diagram for SCR_CampaignFactionManager:

Public Member Functions
SCR_CampaignFaction	GetEnemyFaction (notnull SCR_CampaignFaction alliedFaction)
SCR_CampaignFaction	GetCampaignFactionByKey (string factionKey)
SCR_CampaignFaction	GetCampaignFactionByIndex (int index)
int	GetRankRequestCooldown (SCR_ECharacterRank rankID)
int	GetRankRadioRespawnCooldown (SCR_ECharacterRank rankID)
int	GetRankFastTravelCooldown (SCR_ECharacterRank rankID)
Public Member Functions inherited from SCR_FactionManager
ScriptInvoker	GetOnPlayerFactionCountChanged ()
ScriptInvokerBase< SCR_FactionManager_PlayerFactionChanged >	GetOnPlayerFactionChanged_S ()
	return Script invoker on player faction changed (Server only)
Faction	GetPlayerFaction (int playerId)
	Return affiliated faction of provided player by their id.
Faction	GetLocalPlayerFaction ()
	Return affiliated faction of local player.
int	GetFactionPlayerCount (Faction faction)
	Returns current count of players assigned to the provided faction.
int	GetSortedFactionsList (out notnull SCR_SortedArray< SCR_Faction > outFactions)
	Get factions sorted according to their own custom order.
SCR_RankID	GetRankByID (SCR_ECharacterRank rankID)
array< ref SCR_RankID >	GetAllAvailableRanks ()
bool	IsRankRenegade (SCR_ECharacterRank rankID)
int	GetRequiredRankXP (SCR_ECharacterRank rankID)
SCR_ECharacterRank	GetRankByXP (int XP)
SCR_ECharacterRank	GetRankNext (SCR_ECharacterRank rank)
SCR_ECharacterRank	GetRankPrev (SCR_ECharacterRank rank)
override void	EOnInit (IEntity owner)
void	SCR_FactionManager (IEntitySource src, IEntity parent)
void	~SCR_FactionManager ()
bool	CanChangeFactionsPlayable ()
	Check if the faction is playable.
void	SetFactionsFriendly (notnull SCR_Faction factionA, notnull SCR_Faction factionB, int playerChanged=-1, bool updateAIs=true)
	Set given factions friendly towards eachother (Replicated if called by server) It is possible to set the same faction friendly towards itself to prevent faction infighting.
void	SetFactionsHostile (notnull SCR_Faction factionA, notnull SCR_Faction factionB, int playerChanged=-1, bool updateAIs=true)
	Set given factions hostile towards eachother (Replicated if called by server) It is possible to set the same faction hostile towards itself to allow faction infighting.
void	UpdatePlayerFaction_S (SCR_PlayerFactionAffiliationComponent playerFactionComponent)
	Authority: Update player faction info for target player with their up-to-date state.
Public Member Functions inherited from FactionManager
proto external Faction	GetFactionByKey (FactionKey factionKey)
proto external Faction	GetFactionByIndex (int index)
proto external int	GetFactionIndex (Faction faction)
proto external int	GetFactionsCount ()
	Returns the number of available factions stored in this manager or 0 if none.
proto external int	GetFactionsList (out notnull array< Faction > outFactions)

Additional Inherited Members
Static Public Member Functions inherited from SCR_FactionManager
static Faction	SGetFaction (IEntity entity)
static Faction	SGetPlayerFaction (int playerId)
	Return affiliated faction of provided player by their id.
static Faction	SGetLocalPlayerFaction ()
	Return affiliated faction of local player.
static int	SGetFactionPlayerCount (Faction faction)
	Return count of players assigned to the provided faction.
static void	RequestUpdateAllTargetsFactions ()
	Update all AI perception.
Protected Member Functions inherited from SCR_FactionManager
void	OnPlayerFactionInfoChanged ()
	Update local player faction mapping.
void	OnPlayerFactionSet_S (SCR_PlayerFactionAffiliationComponent playerComponent, Faction faction)
	Authority: Event raised when provided player component has a faction set.
void	OnPlayerFactionCountChanged (Faction faction, int newCount)
	Anyone: Event raised when provided faction's player count changes.
SCR_ECharacterRank	GetRenegadeRank ()
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Authority: Handle disconnected player.
Protected Attributes inherited from SCR_FactionManager
bool	m_bCanChangeFactionsPlayable
ref array< ref SCR_RankID >	m_aRanks
ref SCR_SortedArray< SCR_Faction >	m_SortedFactions = new SCR_SortedArray<SCR_Faction>()
ref map< string, ref array< string > >	m_aAncestors = new map<string, ref array<string>>()
ref array< ref SCR_PlayerFactionInfo >	m_aPlayerFactionInfo = {}
	List of all player faction infos in no particular order. Maintained by the authority.
ref map< int, int >	m_PreviousPlayerFactions = new map<int, int>()
	Map of previous players <playerId : factionIndex>.
ref set< int >	m_ChangedFactions = new set<int>()
	List of indices of factions whose count has changed since last update.
ref map< int, ref SCR_PlayerFactionInfo >	m_MappedPlayerFactionInfo = new map<int, ref SCR_PlayerFactionInfo>()
	Local mapping of playerId to player faction info.
ref map< int, int >	m_PlayerCount = new map<int, int>()
	Mapping of faction id : player count.
ref ScriptInvoker	s_OnPlayerFactionCountChanged = new ScriptInvoker()
ref ScriptInvokerBase< SCR_FactionManager_PlayerFactionChanged >	m_OnPlayerFactionChanged_S

Member Function Documentation

GetCampaignFactionByIndex()

SCR_CampaignFaction SCR_CampaignFactionManager.GetCampaignFactionByIndex

(

int

index

)

Parameters

[in]

index

Returns

GetCampaignFactionByKey()

SCR_CampaignFaction SCR_CampaignFactionManager.GetCampaignFactionByKey

(

string

factionKey

)

Parameters

[in]

factionKey

Returns

GetEnemyFaction()

SCR_CampaignFaction SCR_CampaignFactionManager.GetEnemyFaction

(

notnull SCR_CampaignFaction

alliedFaction

)

Parameters

[in]

alliedFaction

Returns

GetRankFastTravelCooldown()

int SCR_CampaignFactionManager.GetRankFastTravelCooldown

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rankID

Returns

GetRankRadioRespawnCooldown()

int SCR_CampaignFactionManager.GetRankRadioRespawnCooldown

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rankID

Returns

GetRankRequestCooldown()

int SCR_CampaignFactionManager.GetRankRequestCooldown

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rankID

Returns

---

The documentation for this interface was generated from the following file:

• Game/GameMode/FactionManager/SCR_CampaignFactionManager.c