SCR_ArsenalItemListConfig Interface Reference

Public Member Functions
bool	GetArsenalItems (out array< ref SCR_ArsenalItemStandalone > arsenalItems)
bool	GetItemTypeAndModeForPrefab (ResourceName prefab, out SCR_EArsenalItemType itemType, out SCR_EArsenalItemMode itemMode)
array< SCR_ArsenalItem >	GetFilteredArsenalItems (SCR_EArsenalItemType typeFilter, SCR_EArsenalItemMode modeFilter, EArsenalItemDisplayType requiresDisplayType=-1, SCR_Faction checkFaction=null)
	Get arsenal items filtered by SCR_EArsenalItemType filter, caches values.
bool	GetItemModeForPrefab (ResourceName prefab, out SCR_EArsenalItemType itemMode)

Protected Attributes
ref array< ref SCR_ArsenalItemStandalone >	m_aArsenalItems
ref map< SCR_EArsenalItemType, ref array< SCR_ArsenalItem > >	m_mArsenalItemsByType = new map<SCR_EArsenalItemType, ref array<SCR_ArsenalItem>>()

Member Function Documentation

GetArsenalItems()

bool SCR_ArsenalItemListConfig.GetArsenalItems

(

out array< ref SCR_ArsenalItemStandalone >

arsenalItems

)

Parameters

[out]

arsenalItems

Returns

GetFilteredArsenalItems()

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

Get arsenal items filtered by SCR_EArsenalItemType filter, caches values.

Parameters

[in]	filter	Combined flags for available items for this faction (RIFLE, MAGAZINE, EQUIPMENT, RADIOBACKPACK etc.)
[in]	typeFilter
[in]	modeFilter
[in]	requiresDisplayType	Requires the Arsenal data to have display data type (-1 is ignore)
[in]	checkFaction	If a faction is given it will check if the item is part of the faction and if not will filter out the item

Returns

array with availabe arsenal items of give filter types

GetItemModeForPrefab()

bool SCR_ArsenalItemListConfig.GetItemModeForPrefab	(	ResourceName	prefab,
		out SCR_EArsenalItemType	itemMode )

Parameters

[in]	prefab
[out]	itemMode

Returns

GetItemTypeAndModeForPrefab()

bool SCR_ArsenalItemListConfig.GetItemTypeAndModeForPrefab	(	ResourceName	prefab,
		out SCR_EArsenalItemType	itemType,
		out SCR_EArsenalItemMode	itemMode )

Parameters

[in]	prefab
[out]	itemType
[out]	itemMode

Returns

Member Data Documentation

m_aArsenalItems

ref array<ref SCR_ArsenalItemStandalone> SCR_ArsenalItemListConfig.m_aArsenalItems

protected

m_mArsenalItemsByType

ref map<SCR_EArsenalItemType, ref array<SCR_ArsenalItem> > SCR_ArsenalItemListConfig.m_mArsenalItemsByType = new map<SCR_EArsenalItemType, ref array<SCR_ArsenalItem>>()

protected

---

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

• Game/Components/Arsenal/SCR_ArsenalItemListConfig.c