Classes
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, bool printNotFound=true)
SCR_EntityCatalog	GetFactionEntityCatalogOfType (EEntityCatalogType catalogType, FactionKey factionKey, bool printNotFound=true)
SCR_EntityCatalog	GetFactionEntityCatalogOfType (EEntityCatalogType catalogType, notnull SCR_Faction faction, bool printNotFound=true)
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, SCR_EArsenalGameModeType arsenalGameModeType=-1, EArsenalItemDisplayType requiresDisplayType=-1)
bool	GetFactionArsenalItems (out array< SCR_ArsenalItem > arsenalItems, SCR_Faction faction, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, SCR_EArsenalGameModeType arsenalGameModeType=-1, EArsenalItemDisplayType requiresDisplayType=-1)
bool	GetArsenalItems (out array< SCR_ArsenalItem > arsenalItems, notnull SCR_EntityCatalog itemCatalog, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, SCR_EArsenalGameModeType arsenalGameModeType=-1, EArsenalItemDisplayType requiresDisplayType=-1)
int	GetAllArsenalItems (out array< SCR_ArsenalItem > allArsenalItems, SCR_EArsenalItemType typeFilter=-1, SCR_EArsenalItemMode modeFilter=-1, SCR_EArsenalGameModeType arsenalGameModeType=-1, EArsenalItemDisplayType requiresDisplayType=-1)
array< SCR_ArsenalItem >	GetFilteredArsenalItems (SCR_EArsenalItemType typeFilter, SCR_EArsenalItemMode modeFilter, SCR_EArsenalGameModeType arsenalGameModeType, SCR_Faction faction=null, EArsenalItemDisplayType requiresDisplayType=-1)
ResourceName	GetIdentityItemForCharacter (ChimeraCharacter character)
ResourceName	GetDefaultIdentityItem ()
override void	EOnInit (IEntity owner)
void	Init ()
override void	OnPostInit (IEntity owner)
	Editable Mine.

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 1 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 415 of file SCR_EntityCatalogManagerComponent.c.

◆ GetAllArsenalItems()

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

protected

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]	allArsenalItems	output array
[in]	typeFilter	filter for Types (-1 is ignore filter)
[in]	modeFilter	filter for Modes (-1 is ignore filter)
[in]	arsenalGameModeType	The Arsenal Game mode type which dictates which items are available (-1 is unrestricted)
[in]	requiresDisplayType	Requires the Arsenal data to have display data type (-1 is ignore)

Returns: int count of items found

Definition at line 569 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] List of all catalogs within the faction

Returns: List size

Definition at line 110 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]	List	of all catalogs within the faction
[in]	factionKey	key of faction to get all catalogs from

Returns: List size

Definition at line 128 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]	List	of all catalogs within the faction
[in]	faction	faction to get all catalogs from

Returns: List size

Definition at line 149 of file SCR_EntityCatalogManagerComponent.c.

◆ GetArsenalItems() [1/2]

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

protected

Gets a filtered list of arsenal items

Parameters

[out]	arsenalItems	output array
[in]	faction	faction to get items from
[in]	typeFilter	filter for Types (-1 is ignore filter)
[in]	modeFilter	filter for Modes (-1 is ignore filter)
[in]	arsenalGameModeType	The Arsenal Game mode type which dictates which items are available (-1 is unrestricted)
[in]	requiresDisplayType	Requires 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 525 of file SCR_EntityCatalogManagerComponent.c.

◆ GetArsenalItems() [2/2]

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

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

Parameters

[out]	arsenalItems	output array
[in]	typeFilter	filter for Types (-1 is ignore filter)
[in]	modeFilter	filter for Modes (-1 is ignore filter)
[in]	arsenalGameModeType	The Arsenal Game mode type which dictates which items are available (-1 is unrestricted)
[in]	requiresDisplayType	Requires the Arsenal data to have display data type (-1 is ignore)

Returns: False if no config is set and when 0 items are configured

Definition at line 484 of file SCR_EntityCatalogManagerComponent.c.

◆ GetDefaultIdentityItem()

ResourceName GetDefaultIdentityItem ( )

protected

Returns: Default Identity item which is not tied to any faction

Definition at line 654 of file SCR_EntityCatalogManagerComponent.c.

◆ GetEntityCatalogOfType()

SCR_EntityCatalog GetEntityCatalogOfType	(	EEntityCatalogType	catalogType,
		bool	printNotFound = true )

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]	catalogType	Type to get catalog of
[in]	printNotFound	True will print a warning if the given category was not found

Returns: Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list

Definition at line 50 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]	catalogType	Catalog type to get entry in
[in]	prefabToFind	Prefab the entry has that you are looking for
[in]	prioritizeGeneralOfPriorityFaction	If true will search in general catalog then faction catalogs. False it will first search priorityFaction (if any) than General than any other faction
[in]	priorityFaction	If 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 258 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]	catalogType	Catalog type to get entry in
[in]	prefabToFind	Prefab the entry has that you are looking for

Returns: Found Entry, can be null if not found

Definition at line 163 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]	catalogType	Catalog type to get entry in
[in]	prefabToFind	Prefab the entry has that you are looking for
[in]	faction	faction to find entry in

Returns: Found Entry, can be null if not found

Definition at line 186 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]	catalogType	Catalog type to get entry in
[in]	prefabToFind	Prefab the entry has that you are looking for
[in]	prioritizeGeneralCatalog	If true will search in general catalog then faction catalog. False to search the other way around
[in]	faction	faction to find entry in along with general catalog

Returns: Found Entry, can be null if not found

Definition at line 210 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionArsenalItems()

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

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

Parameters

[out]	arsenalItems	output array
[in]	faction	faction to get items from
[in]	typeFilter	filter for Types (-1 is ignore filter)
[in]	modeFilter	filter for Modes (-1 is ignore filter)
[in]	arsenalGameModeType	The Arsenal Game mode type which dictates which items are available (-1 is unrestricted)
[in]	requiresDisplayType	Requires 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 505 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionEntityCatalogOfType() [1/2]

SCR_EntityCatalog GetFactionEntityCatalogOfType	(	EEntityCatalogType	catalogType,
		FactionKey	factionKey,
		bool	printNotFound = true )

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]	catalogType	Type to get catalog of
[in]	factionKey	FactionKey of faction
[in]	printNotFound	True will print a warning if the given category was not found

Returns: Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list

Definition at line 76 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFactionEntityCatalogOfType() [2/2]

SCR_EntityCatalog GetFactionEntityCatalogOfType	(	EEntityCatalogType	catalogType,
		notnull SCR_Faction	faction,
		bool	printNotFound = true )

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]	catalogType	Type to get catalog of
[in]	faction	Faction to find
[in]	printNotFound	True will print a warning if the given category was not found

Returns: Catalog. Can be null if not found. Note that Only one catalog of each type can be in the list

Definition at line 98 of file SCR_EntityCatalogManagerComponent.c.

◆ GetFilteredArsenalItems()

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

protected

Get arsenal items filtered by SCR_EArsenalItemType filter, caches values

Parameters

[in]	typeFilter	Combined flags for available items for this faction (RIFLE, MAGAZINE, EQUIPMENT, RADIOBACKPACK etc.)
[in]	modeFilter	Things like AMMO and CONSUMABLE
[in]	faction	If empty will take non-faction data else will take the data from the faction
[in]	arsenalGameModeType	The Arsenal Game mode type which dictates which items are available (-1 is unrestricted)
[in]	requiresDisplayType	Requires the Arsenal data to have display data type (-1 is ignore)

Returns: array with availabe arsenal items of give filter types

Definition at line 602 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 330 of file SCR_EntityCatalogManagerComponent.c.

◆ GetIdentityItemForCharacter()

ResourceName GetIdentityItemForCharacter ( ChimeraCharacter character )

protected

Returns: Identity item for given character. Will take faction affiliation comp and try to find a valid identity item for the character

Definition at line 623 of file SCR_EntityCatalogManagerComponent.c.

◆ Init()

void Init ( )

protected

Definition at line 708 of file SCR_EntityCatalogManagerComponent.c.

Variable Documentation

◆ data

Get all prefabs that have the spawner data

Definition at line 320 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 326 of file SCR_EntityCatalogManagerComponent.c.

Classes

Functions

Variables

Function Documentation

◆ Attribute()

◆ Faction()

◆ GetAllArsenalItems()

◆ GetAllEntityCatalogs()

◆ GetAllFactionEntityCatalogs() [1/2]

◆ GetAllFactionEntityCatalogs() [2/2]

◆ GetArsenalItems() [1/2]

◆ GetArsenalItems() [2/2]

◆ GetDefaultIdentityItem()

◆ GetEntityCatalogOfType()

◆ GetEntryWithPrefabFromAnyCatalog()

◆ GetEntryWithPrefabFromCatalog()

◆ GetEntryWithPrefabFromFactionCatalog()

◆ GetEntryWithPrefabFromGeneralOrFactionCatalog()

◆ GetFactionArsenalItems()

◆ GetFactionEntityCatalogOfType() [1/2]

◆ GetFactionEntityCatalogOfType() [2/2]

◆ GetFilteredArsenalItems()

◆ GetFilteredEditorPrefabsOfAllFactions()

◆ GetIdentityItemForCharacter()

◆ Init()

Variable Documentation

◆ data

◆ true