SCR_ArsenalItem Class Reference

Inheritance diagram for SCR_ArsenalItem:

Protected Member Functions
SCR_EArsenalItemType	GetItemType ()
SCR_EArsenalItemMode	GetItemMode ()
SCR_EArsenalGameModeType	GetArsenalGameModeTypes ()
ResourceName	GetItemResourceName ()
Resource	GetItemResource ()
SCR_ArsenalItemDisplayData	GetDisplayDataOfType (EArsenalItemDisplayType displayType)
SCR_ECharacterRank	GetRequiredRank ()
bool	GetUseMilitarySupplyAllocation ()
int	GetSupplyCost (SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts=true)
int	GetSupplyRefundAmount (SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts=true)
int	GetMilitarySupplyAllocationCost (SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts=true)
int	GetRefundAmountValue ()
override void	InitData (notnull SCR_EntityCatalogEntry entry)
override void	PostInitData (notnull SCR_EntityCatalogEntry entry)

Static Protected Member Functions
static void	AddAdditionalCosts (notnull SCR_EntityCatalogEntry entry, Resource resource, inout array< SCR_ArsenalItem > arsenalCosts, inout array< SCR_NonArsenalItemCostCatalogData > nonArsenalCosts)

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
SCR_ECharacterRank	m_eRequiredRank
bool	m_bUseMilitarySupplyAllocation
ref array< SCR_ArsenalItem >	m_aAdditionalCosts
ref array< SCR_NonArsenalItemCostCatalogData >	m_aNonArsenalAdditionalCosts
ref map< SCR_EArsenalSupplyCostType, ref SCR_ArsenalAlternativeCostData >	m_mArsenalAlternativeCostData
SCR_EntityCatalogEntry	m_EntryParent
ref Resource	m_ItemResource

Detailed Description

Definition at line 2 of file SCR_ArsenalItem.c.

Member Function Documentation

AddAdditionalCosts()

void SCR_ArsenalItem::AddAdditionalCosts ( notnull SCR_EntityCatalogEntry entry, Resource resource, inout array< SCR_ArsenalItem > arsenalCosts, inout array< SCR_NonArsenalItemCostCatalogData > nonArsenalCosts )

inlinestaticprotected

Definition at line 269 of file SCR_ArsenalItem.c.

GetArsenalGameModeTypes()

SCR_EArsenalGameModeType SCR_ArsenalItem::GetArsenalGameModeTypes ( )

inlineprotected

Returns

Get the valid arsenal mode types

Definition at line 53 of file SCR_ArsenalItem.c.

GetDisplayDataOfType()

SCR_ArsenalItemDisplayData SCR_ArsenalItem::GetDisplayDataOfType ( EArsenalItemDisplayType displayType )

inlineprotected

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

Definition at line 79 of file SCR_ArsenalItem.c.

GetItemMode()

SCR_EArsenalItemMode SCR_ArsenalItem::GetItemMode ( )

inlineprotected

Returns

Definition at line 46 of file SCR_ArsenalItem.c.

GetItemResource()

Resource SCR_ArsenalItem::GetItemResource ( )

inlineprotected

Returns

Definition at line 70 of file SCR_ArsenalItem.c.

GetItemResourceName()

ResourceName SCR_ArsenalItem::GetItemResourceName ( )

inlineprotected

Returns

Definition at line 60 of file SCR_ArsenalItem.c.

GetItemType()

SCR_EArsenalItemType SCR_ArsenalItem::GetItemType ( )

inlineprotected

Returns

Definition at line 39 of file SCR_ArsenalItem.c.

GetMilitarySupplyAllocationCost()

int SCR_ArsenalItem::GetMilitarySupplyAllocationCost ( SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts = true )

inlineprotected

Definition at line 181 of file SCR_ArsenalItem.c.

GetRefundAmountValue()

int SCR_ArsenalItem::GetRefundAmountValue ( )

inlineprotected

Definition at line 222 of file SCR_ArsenalItem.c.

GetRequiredRank()

SCR_ECharacterRank SCR_ArsenalItem::GetRequiredRank ( )

inlineprotected

Returns

Rank required of player in order to obtain the item from the arsenal. Only valid when Item's ranks are required

Definition at line 92 of file SCR_ArsenalItem.c.

GetSupplyCost()

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

inlineprotected

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

Definition at line 111 of file SCR_ArsenalItem.c.

GetSupplyRefundAmount()

int SCR_ArsenalItem::GetSupplyRefundAmount ( SCR_EArsenalSupplyCostType supplyCostType, bool addAdditionalCosts = true )

inlineprotected

Definition at line 146 of file SCR_ArsenalItem.c.

GetUseMilitarySupplyAllocation()

bool SCR_ArsenalItem::GetUseMilitarySupplyAllocation ( )

inlineprotected

Returns

Whether item uses Military Supply Allocation or not

Definition at line 99 of file SCR_ArsenalItem.c.

InitData()

override void SCR_ArsenalItem::InitData ( notnull SCR_EntityCatalogEntry entry )

inlineprotected

Definition at line 228 of file SCR_ArsenalItem.c.

PostInitData()

override void SCR_ArsenalItem::PostInitData ( notnull SCR_EntityCatalogEntry entry )

inlineprotected

Definition at line 255 of file SCR_ArsenalItem.c.

Member Data Documentation

m_aAdditionalCosts

ref array<SCR_ArsenalItem> SCR_ArsenalItem::m_aAdditionalCosts

protected

Definition at line 29 of file SCR_ArsenalItem.c.

m_aArsenalAlternativeCostData

ref array<ref SCR_ArsenalAlternativeCostData> SCR_ArsenalItem::m_aArsenalAlternativeCostData

protected

Definition at line 20 of file SCR_ArsenalItem.c.

m_aArsenalDisplayData

ref array<ref SCR_ArsenalItemDisplayData> SCR_ArsenalItem::m_aArsenalDisplayData

protected

Definition at line 17 of file SCR_ArsenalItem.c.

m_aNonArsenalAdditionalCosts

ref array<SCR_NonArsenalItemCostCatalogData> SCR_ArsenalItem::m_aNonArsenalAdditionalCosts

protected

Definition at line 30 of file SCR_ArsenalItem.c.

m_bUseMilitarySupplyAllocation

bool SCR_ArsenalItem::m_bUseMilitarySupplyAllocation

protected

Definition at line 26 of file SCR_ArsenalItem.c.

m_eArsenalGameModeTypes

SCR_EArsenalGameModeType SCR_ArsenalItem::m_eArsenalGameModeTypes

protected

Definition at line 11 of file SCR_ArsenalItem.c.

m_eItemMode

SCR_EArsenalItemMode SCR_ArsenalItem::m_eItemMode

protected

Definition at line 8 of file SCR_ArsenalItem.c.

m_eItemType

SCR_EArsenalItemType SCR_ArsenalItem::m_eItemType

protected

Definition at line 5 of file SCR_ArsenalItem.c.

m_EntryParent

SCR_EntityCatalogEntry SCR_ArsenalItem::m_EntryParent

protected

Definition at line 34 of file SCR_ArsenalItem.c.

m_eRequiredRank

SCR_ECharacterRank SCR_ArsenalItem::m_eRequiredRank

protected

Definition at line 23 of file SCR_ArsenalItem.c.

m_iSupplyCost

int SCR_ArsenalItem::m_iSupplyCost

protected

Definition at line 14 of file SCR_ArsenalItem.c.

m_ItemResource

ref Resource SCR_ArsenalItem::m_ItemResource

protected

Definition at line 35 of file SCR_ArsenalItem.c.

m_mArsenalAlternativeCostData

ref map<SCR_EArsenalSupplyCostType, ref SCR_ArsenalAlternativeCostData> SCR_ArsenalItem::m_mArsenalAlternativeCostData

protected

Definition at line 32 of file SCR_ArsenalItem.c.

---

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

• scripts/Game/Components/Arsenal/SCR_ArsenalItem.c