SCR_WeaponRackSlotEntity Interface Reference

Inheritance diagram for SCR_WeaponRackSlotEntity:

Public 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)
	Return whether it is possible to create an item.
void	SpawnNewItem (Resource itemResource, SCR_ArsenalItem arsenalData, SCR_ArsenalItemDisplayData itemDisplayData=null, bool deleteExisting=false)
	Create a new item in this slot.
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

Constructor & Destructor Documentation

SCR_WeaponRackSlotEntity()

void SCR_WeaponRackSlotEntity.SCR_WeaponRackSlotEntity	(	IEntitySource	src,
		IEntity	parent
	)

~SCR_WeaponRackSlotEntity()

void SCR_WeaponRackSlotEntity.~SCR_WeaponRackSlotEntity

(

)

Member Function Documentation

CanSpawnItem()

bool SCR_WeaponRackSlotEntity.CanSpawnItem

(

bool

deleteExisting = false

)

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

GetCurrentOccupiedItemMode()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity.GetCurrentOccupiedItemMode

(

)

GetCurrentOccupiedItemType()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity.GetCurrentOccupiedItemType

(

)

GetSlotSupportedItemModes()

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity.GetSlotSupportedItemModes

(

)

GetSlotSupportedItemTypes()

SCR_EArsenalItemType SCR_WeaponRackSlotEntity.GetSlotSupportedItemTypes

(

)

RemoveItem()

void SCR_WeaponRackSlotEntity.RemoveItem

(

)

Delete the slot's item (first found child)

SpawnNewItem()

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

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

Member Data Documentation

m_eCurrentItemMode

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity.m_eCurrentItemMode

protected

m_eCurrentItemType

SCR_EArsenalItemType SCR_WeaponRackSlotEntity.m_eCurrentItemType

protected

m_eSupportedItemModes

SCR_EArsenalItemMode SCR_WeaponRackSlotEntity.m_eSupportedItemModes

protected

m_eSupportedItemTypes

SCR_EArsenalItemType SCR_WeaponRackSlotEntity.m_eSupportedItemTypes

protected

---

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

• Game/Campaign/SCR_WeaponRackSlotEntity.c