Go to the source code of this file.
◆ ScriptInvoker_FactionPlayableChanged
◆ ScriptInvoker_FactionPlayableChangedMethod
◆ BaseContainerProps()
◆ DoCheckIfFactionFriendly()
| override bool BaseContainerProps::DoCheckIfFactionFriendly |
( |
Faction |
faction | ) |
|
Check if provided faction is friendly
Definition at line 320 of file SCR_Faction.c.
◆ GetAllFactionEntityCatalogs()
| int BaseContainerProps::GetAllFactionEntityCatalogs |
( |
notnull out array< SCR_EntityCatalog > |
outEntityCatalogs | ) |
|
Get all entity catalogs within the faction The catalogs contain all entities part of the faction
- Parameters
-
| [out] | List | of all catalogs within the faction |
- Returns
- List size
- Parameters
-
- Returns
- number of result's entries
Definition at line 547 of file SCR_Faction.c.
◆ GetBaseCallsignByIndex()
| SCR_MilitaryBaseCallsign BaseContainerProps::GetBaseCallsignByIndex |
( |
int |
index, |
|
|
int |
offset = 0 |
|
) |
| |
◆ GetBaseCallsignIndexes()
| array<int> BaseContainerProps::GetBaseCallsignIndexes |
( |
| ) |
|
◆ GetCallsignInfo()
◆ GetCanCreateOnlyPredefinedGroups()
| bool BaseContainerProps::GetCanCreateOnlyPredefinedGroups |
( |
| ) |
|
◆ GetFactionEntityCatalogOfType()
Get Entity catalog of specific type linked to faction The catalog contains all entities part of the faction of that specific type
- Parameters
-
| catalogType | Type to get catalog of |
- Returns
- Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list
- Parameters
-
- Returns
Definition at line 517 of file SCR_Faction.c.
◆ GetFactionFlag()
| ResourceName BaseContainerProps::GetFactionFlag |
( |
| ) |
|
◆ GetFactionFlagMaterial()
| ResourceName BaseContainerProps::GetFactionFlagMaterial |
( |
| ) |
|
◆ GetFactionLabel()
◆ GetFactionRadioEncryptionKey()
| string BaseContainerProps::GetFactionRadioEncryptionKey |
( |
| ) |
|
◆ GetFactionRadioFrequency()
| int BaseContainerProps::GetFactionRadioFrequency |
( |
| ) |
|
◆ GetFlagName()
| ResourceName BaseContainerProps::GetFlagName |
( |
int |
index | ) |
|
◆ GetFlagNames()
| int BaseContainerProps::GetFlagNames |
( |
out array< string > |
flagNames | ) |
|
◆ GetGroupFlagImageSet()
| ResourceName BaseContainerProps::GetGroupFlagImageSet |
( |
| ) |
|
◆ GetGroupFlagTextures()
| int BaseContainerProps::GetGroupFlagTextures |
( |
out array< ResourceName > |
textures | ) |
|
◆ GetOnFactionPlayableChanged()
Get On Playable Changed Script Invoker
- Returns
- ScriptInvoker_FactionPlayableChanged OnFactionPlayableChanged
-
Definition at line 306 of file SCR_Faction.c.
◆ GetOrder()
| int BaseContainerProps::GetOrder |
( |
| ) |
|
- Returns
- Order in which the faction appears in the list. Lower values are first.
-
Definition at line 78 of file SCR_Faction.c.
◆ GetOutlineFactionColor()
| Color BaseContainerProps::GetOutlineFactionColor |
( |
| ) |
|
◆ GetPlayerCount()
| int BaseContainerProps::GetPlayerCount |
( |
| ) |
|
◆ GetPlayersInFaction()
| int BaseContainerProps::GetPlayersInFaction |
( |
notnull out array< int > |
players | ) |
|
◆ GetPredefinedGroups()
| void BaseContainerProps::GetPredefinedGroups |
( |
notnull array< ref SCR_GroupPreset > |
groupArray | ) |
|
◆ GetRankByID()
◆ GetRankInsignia()
◆ GetRankName()
◆ GetRankNameShort()
◆ GetRankNameUpperCase()
◆ Init()
| override void BaseContainerProps::Init |
( |
IEntity |
owner | ) |
|
◆ InitFactionIsPlayable()
| void BaseContainerProps::InitFactionIsPlayable |
( |
bool |
isPlayable | ) |
|
Init faction is playable. Called on Init (if server) and on server join (is Client)
- Parameters
-
| isPlayable | Bool to set is playable |
| isPlayable | |
Definition at line 212 of file SCR_Faction.c.
◆ InitializeFaction()
| void BaseContainerProps::InitializeFaction |
( |
| ) |
|
◆ IsInherited()
| bool BaseContainerProps::IsInherited |
( |
string |
factionKey | ) |
|
Check if the faction is inherited from a faction with given faction key.
- Parameters
-
| factionKey | Ancestor faction key |
- Returns
- True when inherited
- Parameters
-
- Returns
Definition at line 227 of file SCR_Faction.c.
◆ IsPlayable()
| bool BaseContainerProps::IsPlayable |
( |
| ) |
|
Check if the faction is playable. Non-playable factions will not appear in the respawn menu.
- Returns
- True when playable
-
Definition at line 197 of file SCR_Faction.c.
◆ SCR_BaseContainerCustomTitleField()
◆ ScriptInvoker_FactionPlayableChangedMethod()
◆ SetAncestors()
| void BaseContainerProps::SetAncestors |
( |
notnull array< string > |
ancestors | ) |
|
◆ SetFactionFlagMaterial()
| void BaseContainerProps::SetFactionFlagMaterial |
( |
ResourceName |
materialResource | ) |
|
◆ SetFactionFriendly()
| void BaseContainerProps::SetFactionFriendly |
( |
notnull Faction |
faction | ) |
|
Add given faction as friendly towards this faction (Server Only) Called by SCR_FactionManager please use the SCR_FactionManager.SetFactionsFriendly function instead of this to make sure the setting is mirrored! If you add factionA friendly towards factionB but not the other way around then factionA will not retaliate if shot at by factionB
- Parameters
-
| faction | Faction to set friendly |
| faction | |
Definition at line 335 of file SCR_Faction.c.
◆ SetFactionHostile()
| void BaseContainerProps::SetFactionHostile |
( |
notnull Faction |
faction | ) |
|
Remove given faction as friendly towards this faction (Server Only) Called by SCR_FactionManager please use the SCR_FactionManager.SetFactionsHostile function instead of this to make sure the setting is mirrored! If you add factionB hostile towards factionA but not the other way around then factionA will not retaliate if shot at by factionB
- Parameters
-
| faction | Faction to set hostile |
| faction | |
Definition at line 350 of file SCR_Faction.c.
◆ SetIsPlayable()
| void BaseContainerProps::SetIsPlayable |
( |
bool |
isPlayable, |
|
|
bool |
killPlayersIfNotPlayable = false |
|
) |
| |
Set if the faction is playable. Non-playable factions will not appear in the respawn menu. Note that this is not broadcasted on the SCR_Faction side
- Parameters
-
| isPlayable | Bool to set is playable |
| killPlayersIfNotPlayable | Bool kills all players if on server if faction is set isplayable false |
| isPlayable | |
| killPlayersIfNotPlayable | |
Definition at line 244 of file SCR_Faction.c.
◆ m_aAncestors
| protected ref array<string> m_aAncestors |
◆ m_aBaseCallsigns
| protected ref array<ref SCR_MilitaryBaseCallsign> m_aBaseCallsigns |
◆ m_aEntityCatalogs
◆ m_aFlagNames
| protected ref array<string> m_aFlagNames |
◆ m_aFriendlyFactionsIds
| protected ref array<string> m_aFriendlyFactionsIds |
◆ m_aGroupFlags
| protected ref array<ResourceName> m_aGroupFlags |
◆ m_aPredefinedGroups
◆ m_aRanks
◆ m_bCatalogInitDone
| protected bool m_bCatalogInitDone |
◆ m_bCreateOnlyPredefinedGroups
| protected bool m_bCreateOnlyPredefinedGroups |
◆ m_bFriendlyToSelf
| protected bool m_bFriendlyToSelf |
◆ m_bIsPlayable
| private bool m_bIsPlayable |
◆ m_CallsignInfo
◆ m_FactionFlagMaterial
| protected ResourceName m_FactionFlagMaterial |
◆ m_FactionLabel
◆ m_FriendlyFactions
◆ m_iFactionRadioFrequency
| protected int m_iFactionRadioFrequency |
◆ m_iOrder
◆ m_mEntityCatalogs
◆ m_OnFactionPlayableChanged
◆ m_OutlineFactionColor
| private ref Color m_OutlineFactionColor |
◆ m_sFactionFlag
| private ResourceName m_sFactionFlag |
◆ m_sFactionRadioEncryptionKey
| protected string m_sFactionRadioEncryptionKey |
◆ m_sGroupFlagsImageSet
| protected ResourceName m_sGroupFlagsImageSet |
1.8.17