EquipmentStorageComponent Interface Reference

Current storage variant uses equipment storage slots to attach equipment to different item variants (eg Flashlight attached to Jacket) supports automatic repositioning at runtime based on parent's active mesh variant (rigged and static) dynamic scaling of slots is not supported, which means that available storage slots should be configured ahead on target prefab. More...

Inheritance diagram for EquipmentStorageComponent:

Additional Inherited Members
Public Member Functions inherited from BaseInventoryStorageComponent
proto external bool	Contains (IEntity item)
	Check if an item is inside this storage.
proto external InventoryStorageSlot	FindItemSlot (IEntity item)
	Find the item slot.
proto external int	GetSlotsCount ()
	Returns the number of slots in this storage.
proto external InventoryStorageSlot	GetSlot (int slotID)
	Return slot for specified id.
proto external IEntity	Get (int slotID)
	Get item at slot ID.
proto external int	GetAll (out notnull array< IEntity > outItems)
proto external int	GetPriority ()
proto external EStoragePurpose	GetPurpose ()
proto external InventoryStorageSlot	FindSuitableSlotForItem (IEntity item)
proto external bool	IsCompartment ()
	does current storage serves as a compartment of other storage
proto external void	GetOwnedItems (out notnull array< InventoryItemComponent > outItemsComponents)
	Fills array with attached items including items from storage compartments.
proto external bool	GetOwnedStorages (out notnull array< BaseInventoryStorageComponent > outStorages, int depth, bool includeHierarchy)
	Fills array with attached storages up to provided hierarchy depth for every top level storage depth with even number will reach compartments level and odd will reach storages attached to slots (including compartment slots)
proto external float	GetWeightFromResource (ResourceName resourceName)
	Get the weight of a prefab.
proto external vector	GetMaxDimensionCapacity ()
proto external float	GetMaxVolumeCapacity ()
proto external float	GetOccupiedSpace ()
	Returns amount of space occupied by attached items.
proto external bool	PerformDimensionValidation (IEntity item)
	Performs dimension validation.
proto external bool	PerformVolumeValidation (IEntity item, bool includeDimensionValidation=true)
	Performs item volume and (optionally) dimension validation.
proto external bool	PerformVolumeValidationForResource (ResourceName resourceName, bool includeDimensionValidation=true)
	Performs prefab volume and (optionally) dimension validation.
proto external int	GetEstimatedCountFitForItem (IEntity item)
	Get an estimate of how many times the item can fit in the inventory.
proto external int	GetEstimatedCountFitForResource (ResourceName resourceName)
	Get an estimate of how many times the resource can fit in the inventory.
bool	OnOverrideCanStoreItem ()
	It should return true or false depending if the scripter wants to override the behavior of the C++ function or not.
bool	OnOverrideCanStoreResource ()
	It should return true or false depending if the scripter wants to override the behavior of the C++ function or not.
bool	OnOverrideCanRemoveItem ()
	It should return true or false depending if the scripter wants to override the behavior of the C++ function or not.
bool	OnOverrideCanReplaceItem ()
	It should return true or false depending if the scripter wants to override the behavior of the C++ function or not.
bool	CanStoreItem (IEntity item, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.
bool	CanStoreResource (ResourceName resourceName, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.
bool	CanRemoveItem (IEntity item)
	Implemented logics for can remove here,.
bool	CanReplaceItem (IEntity nextItem, int slotID)
	Implemented logics for can replace to nextItem at slotID,.
Public Member Functions inherited from InventoryItemComponent
proto external IEntity	GetOwner ()
	Returns Entity owner of current component instance.
proto external bool	IsLocked ()
	Returns locked state of item (for both user and system locks)
proto external bool	IsUserLocked ()
proto external bool	IsSystemLocked ()
proto external InventoryStorageSlot	GetParentSlot ()
proto external ItemAttributeCollection	GetAttributes ()
proto external void	HideOwner ()
	Hide owner entity.
proto external void	ShowOwner ()
	Show owner entity.
proto external void	SetTraceable (bool traceable)
	Set the entity to be traceable or not.
proto external void	DisablePhysics ()
	Disable owners physical interactions.
proto external void	EnablePhysics ()
	Enable owners physical interactions.
proto external void	ActivateOwner (bool active)
	Enable/Disable entity active state.
proto external float	GetAdditionalWeight ()
	Returns the current additional weight.
proto external void	SetAdditionalWeight (float additionalWeight)
	IMPORTANT* Could only be called on the master.
proto external float	GetTotalWeight ()
	Returns the weight + the additional weight.
proto external float	GetAdditionalVolume ()
	Returns the current additional volume.
proto external void	SetAdditionalVolume (float additionalVolume)
	IMPORTANT* Could only be called on the master.
proto external float	GetTotalVolume ()
	Returns the volume + the additional volume.
proto external void	PlaceOnGround (IEntity callerEntity=null)
	IMPORTANT* This function is heavy in performance because of the multiple traces used inside the function.
proto external bool	IsHiddenInVicnity ()
	returns true if item should be hidden
proto external UIInfo	GetUIInfo ()
	Returns UI info of this item.
proto external bool	RequestUserLock (IEntity caller, bool locked)
	Set external lock on item optional caller is entity that manipulates with item and has inventory manager present (usually character)
proto external BaseItemAttributeData	FindAttribute (TypeName typeName)
	Convinience method Finds first occurance of the coresponding attribute data object in owned PrefabData AttributeCollection.
proto external IEntity	CreatePreviewEntity (BaseWorld world, int camera)
	Creates preview entity in the provided world.
void	OnDelete (IEntity owner)
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()
Public Attributes inherited from InventoryItemComponent
ref ScriptInvoker< bool >	m_OnLockedStateChangedInvoker = new ScriptInvoker<bool>()
ref ScriptInvoker< InventoryStorageSlot, InventoryStorageSlot >	m_OnParentSlotChangedInvoker = new ScriptInvoker<InventoryStorageSlot, InventoryStorageSlot>()
Protected Member Functions inherited from ScriptedBaseInventoryStorageComponent
override void	UpdateUI ()
	Virtual method for updating the UI when an item is removed/added.
Protected Member Functions inherited from BaseInventoryStorageComponent
proto external void	SetupSlotHooks (InventoryStorageSlot ownedSlot, int slotID)
	IMPORTANT* Should be called upon initialization of slot instance provide newly created slot and desired slot ID.
proto external void	ReleaseSlotHooks (InventoryStorageSlot ownedSlot)
	IMPORTANT* Should be called before transfering ownership of holded slot instance In majority of cases should be unnecessary (when storage manages creation and destruction of slots on its own)
void	OnAddedToSlot (IEntity item, int slotID)
	Will be called when item is added to slot.
void	OnRemovedFromSlot (IEntity item, int slotID)
	Will be called when item is removed from slot IMPORTANT* This is called after the C++ event.
InventoryStorageSlot	GetEmptySlotForItem (IEntity item)
	Usually any slot that item can be inserted to.
int	GetSlotsCountScr ()
	Should Return slots count.
InventoryStorageSlot	GetSlotScr (int slotID)
	Should Return slot for specified id.
ref BaseInventoryTask	RemoveItem (IEntity item)
	Called locally per instance, implement remove logics here.
ref BaseInventoryTask	InsertItem (IEntity item, int slotID)
	Called locally per instance, implement insertion logics here, Manager will provide slotID of -1 in case slot is irrelevant.
bool	ShouldPreviewAttachedItems ()
	Will be called to estimate if storage children has to be included in preview.
void	OnManagerChanged (InventoryStorageManagerComponent manager)
	Will be called when manager is changed, manager can be null if there is no manager in hierarchy (item drop in world).
Protected Member Functions inherited from InventoryItemComponent
bool	ShouldChangeVisibilityOfHierarchy ()
bool	ShouldHideInVicinity ()
	implement custom visibility behavior in vicinity
bool	OverridePlacementTransform (IEntity caller, out vector computedTransform[4])
	Override final transformation of dropped item, return true in case transformation should be applied.

Detailed Description

Current storage variant uses equipment storage slots to attach equipment to different item variants (eg Flashlight attached to Jacket) supports automatic repositioning at runtime based on parent's active mesh variant (rigged and static) dynamic scaling of slots is not supported, which means that available storage slots should be configured ahead on target prefab.

---

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

• GameCode/Components/InventorySystem/EquipmentStorageComponent.c