SCR_ArsenalItem.c File Reference

Go to the source code of this file.

Classes
class	SCR_ArsenalItem
class	SCR_ArsenalAlternativeCostSellAmountData

Functions
SCR_ArsenalItem SCR_BaseEntityCatalogData	BaseContainerProps ()
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)
SCR_ArsenalItem SCR_BaseEntityCatalogData	BaseContainerCustomEnumWithValue (SCR_EArsenalSupplyCostType, "m_eAlternativeCostType", "m_iSupplyCost", "1", "%1 - Supply cost: %2")

Variables
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

Function Documentation

BaseContainerCustomEnumWithValue()

SCR_ArsenalItem SCR_BaseEntityCatalogData BaseContainerCustomEnumWithValue	(	SCR_EArsenalSupplyCostType	,
		"m_eAlternativeCostType"	,
		"m_iSupplyCost"	,
		"1"	,
		"%1 - Supply cost: %2"	)

Definition at line 400 of file SCR_ArsenalItem.c.

BaseContainerProps()

SCR_ArsenalItem SCR_BaseEntityCatalogData BaseContainerProps

(

)

GetArsenalGameModeTypes()

SCR_EArsenalGameModeType BaseContainerProps::GetArsenalGameModeTypes ( )

protected

Returns

Get the valid arsenal mode types

Definition at line 49 of file SCR_ArsenalItem.c.

GetDisplayDataOfType()

SCR_ArsenalItemDisplayData BaseContainerProps::GetDisplayDataOfType ( EArsenalItemDisplayType displayType )

protected

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 75 of file SCR_ArsenalItem.c.

GetItemMode()

SCR_EArsenalItemMode BaseContainerProps::GetItemMode ( )

protected

Returns

Definition at line 42 of file SCR_ArsenalItem.c.

GetItemResource()

Resource BaseContainerProps::GetItemResource ( )

protected

Returns

Definition at line 66 of file SCR_ArsenalItem.c.

GetItemResourceName()

ResourceName BaseContainerProps::GetItemResourceName ( )

protected

Returns

Definition at line 56 of file SCR_ArsenalItem.c.

GetItemType()

SCR_EArsenalItemType BaseContainerProps::GetItemType ( )

protected

Returns

Definition at line 35 of file SCR_ArsenalItem.c.

GetMilitarySupplyAllocationCost()

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

protected

Definition at line 177 of file SCR_ArsenalItem.c.

GetRefundAmountValue()

int BaseContainerProps::GetRefundAmountValue ( )

protected

Definition at line 218 of file SCR_ArsenalItem.c.

GetRequiredRank()

SCR_ECharacterRank BaseContainerProps::GetRequiredRank ( )

protected

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 88 of file SCR_ArsenalItem.c.

GetSupplyCost()

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

protected

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 107 of file SCR_ArsenalItem.c.

GetSupplyRefundAmount()

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

protected

Definition at line 142 of file SCR_ArsenalItem.c.

GetUseMilitarySupplyAllocation()

bool BaseContainerProps::GetUseMilitarySupplyAllocation ( )

protected

Returns

Whether item uses Military Supply Allocation or not

Definition at line 95 of file SCR_ArsenalItem.c.

InitData()

override void BaseContainerProps::InitData ( notnull SCR_EntityCatalogEntry entry )

protected

Definition at line 224 of file SCR_ArsenalItem.c.

PostInitData()

override void BaseContainerProps::PostInitData ( notnull SCR_EntityCatalogEntry entry )

protected

Definition at line 251 of file SCR_ArsenalItem.c.

Variable Documentation

m_aAdditionalCosts

ref array<SCR_ArsenalItem> m_aAdditionalCosts

protected

Definition at line 25 of file SCR_ArsenalItem.c.

m_aArsenalAlternativeCostData

ref array<ref SCR_ArsenalAlternativeCostData> m_aArsenalAlternativeCostData

protected

Definition at line 16 of file SCR_ArsenalItem.c.

m_aArsenalDisplayData

ref array<ref SCR_ArsenalItemDisplayData> m_aArsenalDisplayData

protected

Definition at line 13 of file SCR_ArsenalItem.c.

m_aNonArsenalAdditionalCosts

ref array<SCR_NonArsenalItemCostCatalogData> m_aNonArsenalAdditionalCosts

protected

Definition at line 26 of file SCR_ArsenalItem.c.

m_bUseMilitarySupplyAllocation

bool m_bUseMilitarySupplyAllocation

protected

Definition at line 22 of file SCR_ArsenalItem.c.

m_eArsenalGameModeTypes

SCR_EArsenalGameModeType m_eArsenalGameModeTypes

protected

Definition at line 7 of file SCR_ArsenalItem.c.

m_eItemMode

SCR_EArsenalItemMode m_eItemMode

protected

Definition at line 4 of file SCR_ArsenalItem.c.

m_eItemType

SCR_EArsenalItemType m_eItemType

protected

Definition at line 1 of file SCR_ArsenalItem.c.

m_EntryParent

SCR_EntityCatalogEntry m_EntryParent

protected

Definition at line 30 of file SCR_ArsenalItem.c.

m_eRequiredRank

SCR_ECharacterRank m_eRequiredRank

protected

Definition at line 19 of file SCR_ArsenalItem.c.

m_iSupplyCost

int m_iSupplyCost

protected

Definition at line 10 of file SCR_ArsenalItem.c.

m_ItemResource

ref Resource m_ItemResource

protected

Definition at line 31 of file SCR_ArsenalItem.c.

m_mArsenalAlternativeCostData

ref map<SCR_EArsenalSupplyCostType, ref SCR_ArsenalAlternativeCostData> m_mArsenalAlternativeCostData

protected

Definition at line 28 of file SCR_ArsenalItem.c.