Arma Reforger Explorer  1.1.0.42
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Data Structures | Functions | Variables
SCR_EntityCatalogManagerComponent.c File Reference

Go to the source code of this file.

Data Structures

class  SCR_EntityCatalogManagerComponentClass
 Manager for non-faction specific entity catalogs as well as getters for faction specific catalogs. More...
 

Functions

SCR_EntityCatalogManagerComponentClass SCR_BaseGameModeComponentClass Attribute (desc:"List of non-faction related Entity catalogs. Each holds a list of entity Prefab and data of a given type. Catalogs of the same type are merged into one. Note this array is moved to a map on init and set to null")
 
SCR_EntityCatalog GetEntityCatalogOfType (EEntityCatalogType catalogType)
 
SCR_EntityCatalog GetFactionEntityCatalogOfType (EEntityCatalogType catalogType, FactionKey factionKey)
 
SCR_EntityCatalog GetFactionEntityCatalogOfType (EEntityCatalogType catalogType, notnull SCR_Faction faction)
 
int GetAllEntityCatalogs (notnull out array< SCR_EntityCatalog > outEntityCatalogs)
 
int GetAllFactionEntityCatalogs (notnull out array< SCR_EntityCatalog > outEntityCatalogs, FactionKey factionKey)
 
int GetAllFactionEntityCatalogs (notnull out array< SCR_EntityCatalog > outEntityCatalogs, notnull SCR_Faction faction)
 
SCR_EntityCatalogEntry GetEntryWithPrefabFromCatalog (EEntityCatalogType catalogType, ResourceName prefabToFind)
 
SCR_EntityCatalogEntry GetEntryWithPrefabFromFactionCatalog (EEntityCatalogType catalogType, ResourceName prefabToFind, notnull SCR_Faction faction)
 
SCR_EntityCatalogEntry GetEntryWithPrefabFromGeneralOrFactionCatalog (EEntityCatalogType catalogType, ResourceName prefabToFind, notnull SCR_Faction faction, bool prioritizeGeneralCatalog=false)
 
SCR_EntityCatalogEntry GetEntryWithPrefabFromAnyCatalog (EEntityCatalogType catalogType, ResourceName prefabToFind, SCR_Faction priorityFaction=null, bool prioritizeGeneralOfPriorityFaction=false)
 
Get all prefabs that have the spawner the given labels and are valid in the editor mode for all factions param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param[out] filteredPrefabsList Filltered array of valid prefabs param includedLabels A list of labels the entity needs all any to have Can be null if any of the other arrays are filled param excludedLabels A list of labels the entity CANNOT have ANY of Can be null if any of the other arrays are filled param needsAllIncludedLabels If true included List all needs to be if false any needs to be true param getFactionLessPrefabs If true than it will also get the prefabs not assigned to any faction return Size of found prefabs *int GetFilteredEditorPrefabsOfAllFactions (EEntityCatalogType catalogType, EEditorMode editorMode, notnull out array< ResourceName > filteredPrefabsList, array< EEditableEntityLabel > includedLabels=null, array< EEditableEntityLabel > excludedLabels=null, bool needsAllIncludedLabels=true, bool getFactionLessPrefabs=false)
 
Get all prefabs that have the spawner the given labels and are valid in the editor mode param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param faction Faction (Optional)
 
bool GetArsenalItems (out array< SCR_ArsenalItem > arsenalItems, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, EArsenalItemDisplayType requiresDisplayType=-1)
 
bool GetFactionArsenalItems (out array< SCR_ArsenalItem > arsenalItems, SCR_Faction faction, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, EArsenalItemDisplayType requiresDisplayType=-1)
 
protected bool GetArsenalItems (out array< SCR_ArsenalItem > arsenalItems, notnull SCR_EntityCatalog itemCatalog, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, EArsenalItemDisplayType requiresDisplayType=-1)
 
int GetAllArsenalItems (out array< SCR_ArsenalItem > allArsenalItems, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, EArsenalItemDisplayType requiresDisplayType=-1)
 
array< SCR_ArsenalItem > GetFilteredArsenalItems (SCR_EArsenalItemType typeFilter, SCR_EArsenalItemMode modeFilter, SCR_Faction faction=null, EArsenalItemDisplayType requiresDisplayType=-1)
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 Editable Mine. More...
 

Variables

Get all prefabs that have the spawner data
 
Get all prefabs that have the spawner the given labels and are valid in the editor mode for all factions param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param[out] filteredPrefabsList Filltered array of valid prefabs param includedLabels A list of labels the entity needs all any to have Can be null if any of the other arrays are filled param excludedLabels A list of labels the entity CANNOT have ANY of Can be null if any of the other arrays are filled param needsAllIncludedLabels If true included List all needs to be true
 

Function Documentation

◆ Attribute()

SCR_EntityCatalogManagerComponentClass SCR_BaseGameModeComponentClass Attribute ( desc:"List of non-faction related Entity catalogs. Each holds a list of entity Prefab and data of a given type. Catalogs of the same type are merged into one. Note this array is moved to a map on init and set to null"  )
Returns

Definition at line 9 of file SCR_EntityCatalogManagerComponent.c.

◆ Faction()

Get all prefabs that have the spawner the given labels and are valid in the editor mode param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param faction Faction ( Optional  )

Definition at line 375 of file SCR_EntityCatalogManagerComponent.c.

◆ GetAllArsenalItems()

int GetAllArsenalItems ( out array< SCR_ArsenalItem >  allArsenalItems,
SCR_EArsenalItemType  typeFilter = -1,
SCR_EArsenalItemMode  modeFilter = -1,
EArsenalItemDisplayType  requiresDisplayType = -1 
)

Get all arsenal items configured in any faction and the non-faction catalogs. Note this is a very intensive seach Values taken from Faction Catalog ITEM

Parameters
[out]allArsenalItemsoutput array
[in]typeFilterfilter for Types (-1 is ignore filter)
[in]modeFilterfilter for Modes (-1 is ignore filter)
[in]requiresDisplayTypeRequires the Arsenal data to have display data type (-1 is ignore)
Returns
int count of items found

Definition at line 509 of file SCR_EntityCatalogManagerComponent.c.

◆ GetAllEntityCatalogs()

int GetAllEntityCatalogs ( notnull out array< SCR_EntityCatalog >  outEntityCatalogs)

Get all entity catalogs not part of a faction The catalogs contain all entities not part of a faction

Parameters
[out]Listof all catalogs within the faction
Returns
List size

Definition at line 95 of file SCR_EntityCatalogManagerComponent.c.

◆ GetAllFactionEntityCatalogs() [1/2]

int GetAllFactionEntityCatalogs ( notnull out array< SCR_EntityCatalog >  outEntityCatalogs,
FactionKey  factionKey 
)

Get all entity catalogs within the faction The catalogs contain all entities part of the faction

Parameters
[out]Listof all catalogs within the faction
[in]factionKeykey of faction to get all catalogs from
Returns
List size

Definition at line 113 of file SCR_EntityCatalogManagerComponent.c.

◆ GetAllFactionEntityCatalogs() [2/2]

int GetAllFactionEntityCatalogs ( notnull out array< SCR_EntityCatalog >  outEntityCatalogs,
notnull SCR_Faction  faction 
)

Get all entity catalogs within the faction The catalogs contain all entities part of the faction

Parameters
[out]Listof all catalogs within the faction
[in]factionfaction to get all catalogs from
Returns
List size

Definition at line 134 of file SCR_EntityCatalogManagerComponent.c.

◆ GetArsenalItems() [1/2]

protected bool GetArsenalItems ( out array< SCR_ArsenalItem >  arsenalItems,
notnull SCR_EntityCatalog  itemCatalog,
SCR_EArsenalItemType  typeFilter = -1,
SCR_EArsenalItemMode  modeFilter = -1,
EArsenalItemDisplayType  requiresDisplayType = -1 
)

Gets a filtered list of arsenal items

Parameters
[out]arsenalItems
[in]itemCatalog
[in]typeFilter
[in]modeFilter
[in]requiresDisplayType
Returns

Definition at line 470 of file SCR_EntityCatalogManagerComponent.c.

◆ GetArsenalItems() [2/2]

bool GetArsenalItems ( out array< SCR_ArsenalItem >  arsenalItems,
SCR_EArsenalItemType  typeFilter = -1,
SCR_EArsenalItemMode  modeFilter = -1,
EArsenalItemDisplayType  requiresDisplayType = -1 
)

Get all arsenal items configured on the faction Values taken from General Catalog ITEM

Parameters
[out]arsenalItemsoutput array
[in]typeFilterfilter for Types (-1 is ignore filter)
[in]modeFilterfilter for Modes (-1 is ignore filter)
[in]requiresDisplayTypeRequires the Arsenal data to have display data type (-1 is ignore)
Returns
bool False if no config is set and when 0 items are configured

Definition at line 431 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntityCatalogOfType()

SCR_EntityCatalog GetEntityCatalogOfType ( EEntityCatalogType  catalogType)

Get Entity catalog of specific type not part of a faction The catalog contains all entities part of the specific type not part of a faction

Parameters
[in]catalogTypeType 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

Definition at line 37 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntryWithPrefabFromAnyCatalog()

SCR_EntityCatalogEntry GetEntryWithPrefabFromAnyCatalog ( EEntityCatalogType  catalogType,
ResourceName  prefabToFind,
SCR_Faction  priorityFaction = null,
bool  prioritizeGeneralOfPriorityFaction = false 
)

Return entry with specific prefab within general or ANY faction catalog Note this search can be quite extensive! Ignores Disabled Entries

Parameters
[in]catalogTypeCatalog type to get entry in
[in]prefabToFindPrefab the entry has that you are looking for
[in]prioritizeGeneralOfPriorityFactionIf true will search in general catalog then faction catalogs. False it will first search priorityFaction (if any) than General than any other faction
[in]priorityFactionIf given it will first try and get the entry from this faction before searching all the other factions
Returns
Found Entry, can be null if not found

Definition at line 243 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntryWithPrefabFromCatalog()

SCR_EntityCatalogEntry GetEntryWithPrefabFromCatalog ( EEntityCatalogType  catalogType,
ResourceName  prefabToFind 
)

Return entry with specific prefab within general catalog Ignores Disabled Entries Note this search can be somewhat extensive

Parameters
[in]catalogTypeCatalog type to get entry in
[in]prefabToFindPrefab the entry has that you are looking for
Returns
Found Entry, can be null if not found

Definition at line 148 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntryWithPrefabFromFactionCatalog()

SCR_EntityCatalogEntry GetEntryWithPrefabFromFactionCatalog ( EEntityCatalogType  catalogType,
ResourceName  prefabToFind,
notnull SCR_Faction  faction 
)

Return entry with specific prefab within faction catalog Ignores Disabled Entries Note this search can be somewhat extensive

Parameters
[in]catalogTypeCatalog type to get entry in
[in]prefabToFindPrefab the entry has that you are looking for
[in]factionfaction to find entry in
Returns
Found Entry, can be null if not found

Definition at line 171 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntryWithPrefabFromGeneralOrFactionCatalog()

SCR_EntityCatalogEntry GetEntryWithPrefabFromGeneralOrFactionCatalog ( EEntityCatalogType  catalogType,
ResourceName  prefabToFind,
notnull SCR_Faction  faction,
bool  prioritizeGeneralCatalog = false 
)

Return entry with specific prefab within general or faction catalog Ignores Disabled Entries Note this search can be somewhat extensive

Parameters
[in]catalogTypeCatalog type to get entry in
[in]prefabToFindPrefab the entry has that you are looking for
[in]prioritizeGeneralCatalogIf true will search in general catalog then faction catalog. False to search the other way around
[in]factionfaction to find entry in along with general catalog
Returns
Found Entry, can be null if not found

Definition at line 195 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionArsenalItems()

bool GetFactionArsenalItems ( out array< SCR_ArsenalItem >  arsenalItems,
SCR_Faction  faction,
SCR_EArsenalItemType  typeFilter = -1,
SCR_EArsenalItemMode  modeFilter = -1,
EArsenalItemDisplayType  requiresDisplayType = -1 
)

Get all arsenal items configured on the faction Values taken from Faction Catalog ITEM

Parameters
[out]arsenalItemsoutput array
[in]factionfaction to get items from
[in]typeFilterfilter for Types (-1 is ignore filter)
[in]modeFilterfilter for Modes (-1 is ignore filter)
[in]requiresDisplayTypeRequires the Arsenal data to have display data type (-1 is ignore)
Returns
bool False if no config is set and when 0 items are configured

Definition at line 451 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionEntityCatalogOfType() [1/2]

SCR_EntityCatalog GetFactionEntityCatalogOfType ( EEntityCatalogType  catalogType,
FactionKey  factionKey 
)

Get Entity catalog of specific type linked to given faction The catalog contains all entities part of the faction of that specific type

Parameters
[in]catalogTypeType to get catalog of
[in]factionKeyFactionKey of faction
Returns
Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list

Definition at line 62 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionEntityCatalogOfType() [2/2]

SCR_EntityCatalog GetFactionEntityCatalogOfType ( EEntityCatalogType  catalogType,
notnull SCR_Faction  faction 
)

Get Entity catalog of specific type linked to given faction The catalog contains all entities part of the faction of that specific type

Parameters
[in]catalogTypeType to get catalog of
[in]factionFaction to find
Returns
Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list

Definition at line 83 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFilteredArsenalItems()

array<SCR_ArsenalItem> GetFilteredArsenalItems ( SCR_EArsenalItemType  typeFilter,
SCR_EArsenalItemMode  modeFilter,
SCR_Faction  faction = null,
EArsenalItemDisplayType  requiresDisplayType = -1 
)

Get arsenal items filtered by SCR_EArsenalItemType filter, caches values

Parameters
[in]typeFilterCombined flags for available items for this faction (RIFLE, MAGAZINE, EQUIPMENT, RADIOBACKPACK etc.)
[in]modeFilterThings like AMMO and CONSUMABLE
[in]factionIf empty will take non-faction data else will take the data from the faction
[in]requiresDisplayTypeRequires the Arsenal data to have display data type (-1 is ignore)
Returns
array with availabe arsenal items of give filter types

Definition at line 541 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFilteredEditorPrefabsOfAllFactions()

Get all prefabs that have the spawner the given labels and are valid in the editor mode for all factions param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param [out] filteredPrefabsList Filltered array of valid prefabs param includedLabels A list of labels the entity needs all any to have Can be null if any of the other arrays are filled param excludedLabels A list of labels the entity CANNOT have ANY of Can be null if any of the other arrays are filled param needsAllIncludedLabels If true included List all needs to be if false any needs to be true param getFactionLessPrefabs If true than it will also get the prefabs not assigned to any faction return Size of found prefabs* int GetFilteredEditorPrefabsOfAllFactions ( EEntityCatalogType  catalogType,
EEditorMode  editorMode,
notnull out array< ResourceName >  filteredPrefabsList,
array< EEditableEntityLabel >  includedLabels = null,
array< EEditableEntityLabel >  excludedLabels = null,
bool  needsAllIncludedLabels = true,
bool  getFactionLessPrefabs = false 
)

Definition at line 315 of file SCR_EntityCatalogManagerComponent.c.

Variable Documentation

◆ data

Get all prefabs that have the spawner data

Definition at line 305 of file SCR_EntityCatalogManagerComponent.c.

◆ true

Get all prefabs that have the spawner the given labels and are valid in the editor mode for all factions param catalogType Type to catalog to get prefabs from param editorMode Editor mode to get valid entries from param [out] filteredPrefabsList Filltered array of valid prefabs param includedLabels A list of labels the entity needs all any to have Can be null if any of the other arrays are filled param excludedLabels A list of labels the entity CANNOT have ANY of Can be null if any of the other arrays are filled param needsAllIncludedLabels If true included List all needs to be true

Definition at line 311 of file SCR_EntityCatalogManagerComponent.c.