SCR_WeaponRackSlotEntity Class Reference

Inheritance diagram for SCR_WeaponRackSlotEntity:

Protected Member Functions
SCR_EArsenalItemType	GetSlotSupportedItemTypes ()
SCR_EArsenalItemMode	GetSlotSupportedItemModes ()
SCR_EArsenalItemMode	GetCurrentOccupiedItemType ()
SCR_EArsenalItemMode	GetCurrentOccupiedItemMode ()
void	RemoveItem ()
	Delete the slot's item (first found child).
bool	CanSpawnItem (bool deleteExisting=false)
void	SpawnNewItem (Resource itemResource, SCR_ArsenalItem arsenalData, SCR_ArsenalItemDisplayData itemDisplayData=null, bool deleteExisting=false)
void	SCR_WeaponRackSlotEntity (IEntitySource src, IEntity parent)
void	~SCR_WeaponRackSlotEntity ()

Protected Attributes
SCR_EArsenalItemType	m_eSupportedItemTypes
SCR_EArsenalItemMode	m_eSupportedItemModes
SCR_EArsenalItemType	m_eCurrentItemType
SCR_EArsenalItemMode	m_eCurrentItemMode

Detailed Description

Definition at line 7 of file SCR_WeaponRackSlotEntity.c.

Constructor & Destructor Documentation

SCR_WeaponRackSlotEntity()

void SCR_WeaponRackSlotEntity::SCR_WeaponRackSlotEntity ( IEntitySource src, IEntity parent )

inlineprotected

Definition at line 131 of file SCR_WeaponRackSlotEntity.c.

~SCR_WeaponRackSlotEntity()

void SCR_WeaponRackSlotEntity::~SCR_WeaponRackSlotEntity ( )

inlineprotected

Definition at line 136 of file SCR_WeaponRackSlotEntity.c.

Member Function Documentation

CanSpawnItem()

bool SCR_WeaponRackSlotEntity::CanSpawnItem ( bool deleteExisting = false )

inlineprotected

Return whether it is possible to create an item

Parameters

deleteExisting

if provided true, return true

Returns

true if the rack has no child entity, false otherwise

Definition at line 57 of file SCR_WeaponRackSlotEntity.c.

GetCurrentOccupiedItemMode()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity::GetCurrentOccupiedItemMode ( )

inlineprotected

Definition at line 37 of file SCR_WeaponRackSlotEntity.c.

GetCurrentOccupiedItemType()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity::GetCurrentOccupiedItemType ( )

inlineprotected

Definition at line 31 of file SCR_WeaponRackSlotEntity.c.

GetSlotSupportedItemModes()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity::GetSlotSupportedItemModes ( )

inlineprotected

Definition at line 25 of file SCR_WeaponRackSlotEntity.c.

GetSlotSupportedItemTypes()

SCR_EArsenalItemType SCR_WeaponRackSlotEntity::GetSlotSupportedItemTypes ( )

inlineprotected

Definition at line 19 of file SCR_WeaponRackSlotEntity.c.

RemoveItem()

void SCR_WeaponRackSlotEntity::RemoveItem ( )

inlineprotected

Delete the slot's item (first found child).

Definition at line 44 of file SCR_WeaponRackSlotEntity.c.

SpawnNewItem()

void SCR_WeaponRackSlotEntity::SpawnNewItem ( Resource itemResource, SCR_ArsenalItem arsenalData, SCR_ArsenalItemDisplayData itemDisplayData = null, bool deleteExisting = false )

inlineprotected

Create a new item in this slot.\ If an item already exists and deleteExisting is false, nothing is done.\ If an item already exists and deleteExisting is true, it is deleted and replaced.

Parameters

itemResource	the wanted item's resource - must not be null
arsenalData	must not be null
itemDisplayData	if provided,
deleteExisting	if true, delete the existing item if there is one

Definition at line 74 of file SCR_WeaponRackSlotEntity.c.

Member Data Documentation

m_eCurrentItemMode

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity::m_eCurrentItemMode

protected

Definition at line 16 of file SCR_WeaponRackSlotEntity.c.

m_eCurrentItemType

SCR_EArsenalItemType SCR_WeaponRackSlotEntity::m_eCurrentItemType

protected

Definition at line 15 of file SCR_WeaponRackSlotEntity.c.

m_eSupportedItemModes

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity::m_eSupportedItemModes

protected

Definition at line 13 of file SCR_WeaponRackSlotEntity.c.

m_eSupportedItemTypes

SCR_EArsenalItemType SCR_WeaponRackSlotEntity::m_eSupportedItemTypes

protected

Definition at line 10 of file SCR_WeaponRackSlotEntity.c.

---

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

• scripts/Game/Campaign/SCR_WeaponRackSlotEntity.c