SCR_ArsenalItem Interface Reference

Inheritance diagram for SCR_ArsenalItem:

Public Member Functions
SCR_EArsenalItemType	GetItemType ()
SCR_EArsenalItemMode	GetItemMode ()
SCR_EArsenalGameModeType	GetArsenalGameModeTypes ()
ResourceName	GetItemResourceName ()
Resource	GetItemResource ()
SCR_ArsenalItemDisplayData	GetDisplayDataOfType (EArsenalItemDisplayType displayType)
	Get display data of given type for displaying items on arsenal display.
int	GetSupplyCost (SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts=true)
	Get supply cost of arsenal item.
override void	InitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog on creation.
override void	PostInitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog after init data is called for all other entries.
Public Member Functions inherited from SCR_BaseEntityCatalogData
bool	IsEnabled ()
	If is Enabled.
void	InitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog on creation.
void	PostInitData (notnull SCR_EntityCatalogEntry entry)
	Called by Catalog after init data is called for all other entries.

Protected Attributes
SCR_EArsenalItemType	m_eItemType
SCR_EArsenalItemMode	m_eItemMode
SCR_EArsenalGameModeType	m_eArsenalGameModeTypes
int	m_iSupplyCost
ref array< ref SCR_ArsenalItemDisplayData >	m_aArsenalDisplayData
ref array< ref SCR_ArsenalAlternativeCostData >	m_aArsenalAlternativeCostData
ref array< SCR_ArsenalItem >	m_aAdditionalCosts
ref array< SCR_NonArsenalItemCostCatalogData >	m_aNonArsenalAdditionalCosts
ref map< SCR_EArsenalSupplyCostType, int >	m_mArsenalAlternativeCostData
SCR_EntityCatalogEntry	m_EntryParent
ref Resource	m_ItemResource
Protected Attributes inherited from SCR_BaseEntityCatalogData
bool	m_bEnabled

Member Function Documentation

GetArsenalGameModeTypes()

SCR_EArsenalGameModeType SCR_ArsenalItem.GetArsenalGameModeTypes

(

)

Returns

Get the valid arsenal mode types

GetDisplayDataOfType()

SCR_ArsenalItemDisplayData SCR_ArsenalItem.GetDisplayDataOfType

(

EArsenalItemDisplayType

displayType

)

Get display data of given type for displaying items on arsenal display.

Parameters

[in]

displayType

type of display data to find

Returns

Display data, can be null if not found

GetItemMode()

SCR_EArsenalItemMode SCR_ArsenalItem.GetItemMode

(

)

Returns

GetItemResource()

Resource SCR_ArsenalItem.GetItemResource

(

)

Returns

GetItemResourceName()

ResourceName SCR_ArsenalItem.GetItemResourceName

(

)

Returns

Implemented in SCR_ArsenalItemStandalone.

GetItemType()

SCR_EArsenalItemType SCR_ArsenalItem.GetItemType

(

)

Returns

GetSupplyCost()

int SCR_ArsenalItem.GetSupplyCost	(	SCR_EArsenalSupplyCostType	supplyCostType,
		bool	addAdditionalCosts = true
	)

Get supply cost of arsenal item.

Parameters

[in]	supplyCostType	What the supply cost is that should be obtained from the arsenal data. If the specific supply cost is not found then Default will be used instead
[in]	addAdditionalCosts	Will add any additional cost to the item, in general these are weapon attachments. You want to turn this false if refunding an item as it should reevaluate the cost depending on the attachments

Returns

Supplycost

InitData()

override void SCR_ArsenalItem.InitData

(

notnull SCR_EntityCatalogEntry

entry

)

Called by Catalog on creation.

Special init for data. To be overidden. Never called if Data is disabled

Parameters

[in]

entry

Entry the data is attached to

Implements SCR_BaseEntityCatalogData.

PostInitData()

override void SCR_ArsenalItem.PostInitData

(

notnull SCR_EntityCatalogEntry

entry

)

Called by Catalog after init data is called for all other entries.

To be overidden. Never called if Data is disabled

Parameters

[in]

entry

Entry the data is attached to

Implements SCR_BaseEntityCatalogData.

Member Data Documentation

m_aAdditionalCosts

ref array<SCR_ArsenalItem> SCR_ArsenalItem.m_aAdditionalCosts

protected

m_aArsenalAlternativeCostData

ref array<ref SCR_ArsenalAlternativeCostData> SCR_ArsenalItem.m_aArsenalAlternativeCostData

protected

m_aArsenalDisplayData

ref array<ref SCR_ArsenalItemDisplayData> SCR_ArsenalItem.m_aArsenalDisplayData

protected

m_aNonArsenalAdditionalCosts

ref array<SCR_NonArsenalItemCostCatalogData> SCR_ArsenalItem.m_aNonArsenalAdditionalCosts

protected

m_eArsenalGameModeTypes

SCR_EArsenalGameModeType SCR_ArsenalItem.m_eArsenalGameModeTypes

protected

m_eItemMode

SCR_EArsenalItemMode SCR_ArsenalItem.m_eItemMode

protected

m_eItemType

SCR_EArsenalItemType SCR_ArsenalItem.m_eItemType

protected

m_EntryParent

SCR_EntityCatalogEntry SCR_ArsenalItem.m_EntryParent

protected

m_iSupplyCost

int SCR_ArsenalItem.m_iSupplyCost

protected

m_ItemResource

ref Resource SCR_ArsenalItem.m_ItemResource

protected

m_mArsenalAlternativeCostData

ref map<SCR_EArsenalSupplyCostType, int> SCR_ArsenalItem.m_mArsenalAlternativeCostData

protected

---

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

• Game/Components/Arsenal/SCR_ArsenalItem.c