SCR_Faction_BIKI Interface Reference

Inheritance diagram for SCR_Faction_BIKI:

Static Public Member Functions
static SCR_EntityCatalog	GetEntityCatalog (notnull SCR_Faction faction, EEntityCatalogType catalogType)
Static Public Member Functions inherited from SCR_Faction
static Faction	GetEntityFaction (notnull IEntity entity)
	Get the provided entity's Faction.

Additional Inherited Members
Public Member Functions inherited from SCR_Faction
int	GetOrder ()
bool	GetCanCreateOnlyPredefinedGroups ()
void	GetPredefinedGroups (notnull array< ref SCR_GroupPreset > groupArray)
bool	IsEnabledAutoGroupCreationWhenFull ()
void	GetGroupRolePresetConfigs (notnull array< SCR_GroupRolePresetConfig > groupArray)
bool	IsGroupRolesConfigured ()
ResourceName	GetFlagName (int index)
int	GetFlagNames (out array< string > flagNames)
ResourceName	GetGroupFlagImageSet ()
ResourceName	GetGroupFlagImageSetOutlines ()
int	GetGroupFlagTextures (out array< ResourceName > textures)
ResourceName	GetFactionFlag ()
ResourceName	GetFactionFlagMaterial ()
void	SetFactionFlagMaterial (ResourceName materialResource)
EEditableEntityLabel	GetFactionLabel ()
SCR_FactionCallsignInfo	GetCallsignInfo ()
Color	GetNotificationFactionColor ()
Color	GetNotificationTextFactionColor ()
Color	GetOutlineFactionColor ()
void	InitializeFaction ()
void	SetAncestors (notnull array< string > ancestors)
bool	IsPlayable ()
	Check if the faction is playable.
bool	IsShownInWelcomeScreenIfNonPlayable ()
	If faction should be shown in the welcome screen if it is not playable.
void	InitFactionIsPlayable (bool isPlayable)
	Init faction is playable.
bool	IsInherited (string factionKey)
	Check if the faction is inherited from a faction with given faction key.
void	SetIsPlayable (bool isPlayable, bool killPlayersIfNotPlayable=false)
	Set if the faction is playable.
ScriptInvoker_FactionPlayableChanged	GetOnFactionPlayableChanged ()
	Get On Playable Changed Script Invoker.
override bool	DoCheckIfFactionFriendly (Faction faction)
	Check if provided faction is friendly.
void	SetFactionFriendly (notnull Faction faction)
	Add given faction as friendly towards this faction Called by SCR_FactionManager please use the SCR_FactionManager.SetFactionsFriendly function instead of this to make sure the setting is mirrored!
void	SetFactionHostile (notnull Faction faction)
	Remove given faction as friendly towards this faction Called by SCR_FactionManager please use the SCR_FactionManager.SetFactionsHostile function instead of this to make sure the setting is mirrored!
int	GetPlayerCount ()
	Get the number of players assigned to this faction.
int	GetPlayersInFaction (notnull out array< int > players)
int	GetFactionRadioFrequency ()
string	GetRankName (SCR_ECharacterRank rankID)
string	GetRankNameUpperCase (SCR_ECharacterRank rankID)
string	GetRankNameShort (SCR_ECharacterRank rankID)
string	GetRankInsignia (SCR_ECharacterRank rankID)
SCR_FactionHomeTerritoryConfig	GetFactionHomeTerritoryConfig ()
SCR_EntityCatalog	GetFactionEntityCatalogOfType (EEntityCatalogType catalogType, bool printNotFound=true)
	Get Entity catalog of specific type linked to faction The catalog contains all entities part of the faction of that specific type.
int	GetAllFactionEntityCatalogs (notnull out array< SCR_EntityCatalog > outEntityCatalogs)
	Get all entity catalogs within the faction The catalogs contain all entities part of the faction.
int	GetFriendlyFactions (notnull out array< Faction > friendlyFactions, bool includeSelf=true)
override void	Init (IEntity owner)
	Called when faction is initialized.
int	GetIndentityVoiceSignal ()
array< int >	GetBaseCallsignIndexes ()
SCR_MilitaryBaseCallsign	GetBaseCallsignByIndex (int index, int offset=0)
ResourceName	GetFactionBackground ()
bool	IsMilitary ()
bool	IsPlayerCommander (int playerId)
bool	IsAICommander ()
void	SetCommanderId (int playerId)
int	GetCommanderId ()
ResourceName	GetCommanderMenuConfig ()
int	GetPlayerLimit ()
void	SetPlayerLimit (int playerLimit)
array< FactionKey >	GetDefaultFriendlyFactions ()
bool	IsDefaultSelfFriendly ()
bool	IsDefaultPlayable ()
Public Member Functions inherited from Faction
proto external FactionIdentity	GetFactionIdentity ()
proto external bool	IsFactionFriendly (Faction otherFaction)
	Returns true if this faction and other faction are friendly.
proto external bool	IsFactionEnemy (Faction otherFaction)
	Returns true if this faction and other faction are hostile.
proto external string	GetFactionName ()
	Returns the name of this faction for via this Faction's UI Info.
proto external FactionKey	GetFactionKey ()
	Returns the identifier of this faction specified in FactionManager.
proto ref Color	GetFactionColor ()
	Returns the color of this faction specified in FactionManager.
proto external UIInfo	GetUIInfo ()
	Returns the UI info of this faction.
proto external string	GetFactionRadioEncryptionKey ()
	Returns the encryption key used for radio transmissions.
Static Public Attributes inherited from SCR_Faction
static const int	AI_COMMANDER_ID = 0
Protected Member Functions inherited from SCR_Faction
SCR_CharacterRank	GetRankByID (SCR_ECharacterRank rankID)
Protected Attributes inherited from SCR_Faction
int	m_iOrder
int	m_iPlayerLimit
ref Color	m_OutlineFactionColor
ref Color	m_NotificationFactionColor
ref Color	m_NotificationTextFactionColor
bool	m_bIsPlayable
bool	m_bShowInWelcomeScreenIfNonPlayable
bool	m_bIsMilitary
ResourceName	m_FactionFlagMaterial
EEditableEntityLabel	m_FactionLabel
bool	m_bFriendlyToSelf
ref array< string >	m_aFriendlyFactionsIds
ref SCR_FactionCallsignInfo	m_CallsignInfo
ref array< ref SCR_GroupRolePresetConfig >	m_aGroupRolePresetConfigs
ref array< ref SCR_GroupPreset >	m_aPredefinedGroups
bool	m_bCreateOnlyPredefinedGroups
bool	m_bEnableAutoGroupCreationWhenFull
int	m_iFactionRadioFrequency
ref array< string >	m_aAncestors
ref ScriptInvoker_FactionPlayableChanged	m_OnFactionPlayableChanged
ref array< ref SCR_CharacterRank >	m_aRanks
ref array< ref SCR_EntityCatalog >	m_aEntityCatalogs
ref array< ResourceName >	m_aGroupFlags
ResourceName	m_sGroupFlagsImageSet
ResourceName	m_sGroupFlagsImageSetOutlines
ref array< string >	m_aFlagNames
ResourceName	m_sFactionBackground
int	m_iIdentityVoiceSignal
ref array< ref SCR_MilitaryBaseCallsign >	m_aBaseCallsigns
ref SCR_FactionHomeTerritoryConfig	m_FactionHomeTerritoryConfig
ResourceName	m_sCommanderMenuEntries
ref map< EEntityCatalogType, ref SCR_EntityCatalog >	m_mEntityCatalogs = new map<EEntityCatalogType, ref SCR_EntityCatalog>()
bool	m_bCatalogInitDone
bool	m_bIsPlayableDefault
ref set< Faction >	m_FriendlyFactions = new set<Faction>
int	m_iCommanderId = AI_COMMANDER_ID

Member Function Documentation

GetEntityCatalog()

static SCR_EntityCatalog SCR_Faction_BIKI.GetEntityCatalog ( notnull SCR_Faction faction, EEntityCatalogType catalogType )

static

Parameters

[in]	faction
[in]	catalogType

Returns

---

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

• WorkbenchGame/ResourceManager/BIKI/SCR_BIKIFactionAssetsExportPlugin.c