Classes
class	AimingModifierAttributes
class	AttachmentAttributes
class	AttachmentsStorageComponentClass
class	BaseEquipedWeaponStorageComponentClass
class	BaseEquipmentStorageComponentClass
class	BaseInventoryStorageComponentClass
class	BaseItemAttributeData
class	BaseUniversalInventoryStorageComponentClass
class	CharacterInventoryStorageComponentClass
class	CharacterModifierAttributes
class	CharacterVicinityComponent
class	CharacterVicinityComponentClass
class	ClothNodeStorageComponentClass
class	EquipedLoadoutStorageComponentClass
class	HolsteredItemAttributes
class	InventoryStorageManagerComponent
class	InventoryStorageSlot
class	ItemActionAnimAttributes
class	ItemAnimationAttributes
class	ItemAttributeCollection
class	ItemMovementSwayAttributes
class	ItemOneHandAnimAttributes
class	ItemPhysicalAttributes
class	ItemPreviewManagerEntityClass
class	LoadoutSlotInfo
class	MultiSlotConfiguration
class	PreviewRenderAttributes
class	SerializerInventoryStorageManagerComponentClass
class	WeaponAttachmentAttributes
class	WeaponAttachmentsStorageComponentClass

Functions
BaseInventoryStorageComponentClass InventoryItemComponentClass	SetupSlotHooks (InventoryStorageSlot ownedSlot, int slotID)
void	ReleaseSlotHooks (InventoryStorageSlot ownedSlot)
proto external sealed bool	Contains (IEntity item)
proto external sealed InventoryStorageSlot	FindItemSlot (IEntity item)
proto external int	GetSlotsCount ()
	Returns the number of slots in this storage.
proto external sealed InventoryStorageSlot	GetSlot (int slotID)
proto external sealed IEntity	Get (int slotID)
proto external sealed InventoryItemComponent	GetItem (int slotID)
proto external sealed int	GetAll (out notnull array< IEntity > outItems, bool includeChildComponents=true)
proto external sealed int	GetPriority ()
proto external sealed 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, bool includeChildComponents=true)
	Fills array with attached items, optionally including items from child storage components.
proto external bool	GetOwnedStorages (out notnull array< BaseInventoryStorageComponent > outStorages, int depth, bool includeHierarchy)
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.
event bool	OnOverrideCanStoreItem ()
event bool	OnOverrideCanStoreResource ()
event bool	OnOverrideCanRemoveItem ()
event bool	OnOverrideCanReplaceItem ()
void	OnAddedToSlot (IEntity item, int slotID)
void	OnRemovedFromSlot (IEntity item, int slotID)
InventoryStorageSlot	GetEmptySlotForItem (IEntity item)
	Usually any slot that item can be inserted to.
event bool	CanStoreItem (IEntity item, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.
event bool	CanStoreResource (ResourceName resourceName, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.
event bool	CanRemoveItem (IEntity item)
	Implemented logics for can remove here,.
event bool	CanReplaceItem (IEntity nextItem, int slotID)
	Implemented logics for can replace to nextItem at slotID,.
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, bool justSpawned)
bool	ShouldPreviewAttachedItems ()
	Will be called to estimate if storage children has to be included in preview.
void	OnManagerChanged (InventoryStorageManagerComponent manager)
void	UpdateUI ()
	Virtual method for updating the UI when an item is removed/added.
EquipedLoadoutStorageComponentClass ScriptedBaseInventoryStorageComponentClass	GetSlotFromArea (typename pAreaType)
	Get the first slot that satisfies the condition : "slot area type is inherited by pAreaType".
proto external int	GetSlotsFromArea (typename pAreaType, out array< ref LoadoutSlotInfo > outSlots)
proto external IEntity	GetClothFromArea (typename pAreaType)
	Get the first cloth entity that satisfies the condition : "slot area type is inherited by pAreaType AND slot has attached entity".
ItemPreviewManagerEntityClass GenericEntityClass	SetPreviewItem (ItemPreviewWidget widget, IEntity item, PreviewRenderAttributes attributes=null, bool forceRefresh=false, int maxLifeTimeMS=30000)
proto external void	SetPreviewItemFromPrefab (ItemPreviewWidget widget, ResourceName prefabResource, PreviewRenderAttributes attributes=null, bool forceRefresh=false, int maxLifeTimeMS=30000)
proto external IEntity	ResolvePreviewEntityForPrefab (ResourceName prefabResource)

Detailed Description

Enumeration Type Documentation

◆ EStoragePurpose [1/2]

enum EStoragePurpose

Enumerator
PURPOSE_UNSET
PURPOSE_DEPOSIT
PURPOSE_WEAPON_PROXY
PURPOSE_GADGET_PROXY
PURPOSE_LOADOUT_PROXY
PURPOSE_ATTACHMENT_PROXY
PURPOSE_EQUIPMENT_ATTACHMENT
PURPOSE_ANY
PURPOSE_UNSET
PURPOSE_DEPOSIT
PURPOSE_WEAPON_PROXY
PURPOSE_GADGET_PROXY
PURPOSE_LOADOUT_PROXY
PURPOSE_ATTACHMENT_PROXY
PURPOSE_EQUIPMENT_ATTACHMENT
PURPOSE_ANY

Definition at line 12 of file EStoragePurpose.c.

◆ EStoragePurpose [2/2]

enum EStoragePurpose

Enumerator
PURPOSE_UNSET
PURPOSE_DEPOSIT
PURPOSE_WEAPON_PROXY
PURPOSE_GADGET_PROXY
PURPOSE_LOADOUT_PROXY
PURPOSE_ATTACHMENT_PROXY
PURPOSE_EQUIPMENT_ATTACHMENT
PURPOSE_ANY
PURPOSE_UNSET
PURPOSE_DEPOSIT
PURPOSE_WEAPON_PROXY
PURPOSE_GADGET_PROXY
PURPOSE_LOADOUT_PROXY
PURPOSE_ATTACHMENT_PROXY
PURPOSE_EQUIPMENT_ATTACHMENT
PURPOSE_ANY

Definition at line 12 of file EStoragePurpose.c.

Function Documentation

◆ CanRemoveItem()

event bool CanRemoveItem ( IEntity item )

protected

Implemented logics for can remove here,.

Definition at line 138 of file BaseInventoryStorageComponent.c.

◆ CanReplaceItem()

event bool CanReplaceItem	(	IEntity	nextItem,
		int	slotID )

protected

Implemented logics for can replace to nextItem at slotID,.

Definition at line 140 of file BaseInventoryStorageComponent.c.

◆ CanStoreItem()

event bool CanStoreItem	(	IEntity	item,
		int	slotID )

protected

Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.

Definition at line 134 of file BaseInventoryStorageComponent.c.

◆ CanStoreResource()

event bool CanStoreResource	(	ResourceName	resourceName,
		int	slotID )

protected

Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant.

Definition at line 136 of file BaseInventoryStorageComponent.c.

◆ Contains()

proto external sealed bool Contains ( IEntity item )

protected

Check if an item is inside this storage.

Parameters

item	Item which meeds to be searched.

Returns: Returns true if the item is inside this storage.

◆ FindItemSlot()

proto external sealed InventoryStorageSlot FindItemSlot ( IEntity item )

protected

Find the item slot.

Parameters

item	Item which meeds to be searched.

Returns: Returns the slot otherwise null.

◆ FindSuitableSlotForItem()

proto external InventoryStorageSlot FindSuitableSlotForItem ( IEntity item )

protected

◆ Get()

proto external sealed IEntity Get ( int slotID )

protected

Get item entity at slot ID.

Parameters

slotID Slot ID

Returns: Returns the entity instance or null if slot empty.

◆ GetAll()

proto external sealed int GetAll	(	out notnull array< IEntity >	outItems,
		bool	includeChildComponents = true )

protected

◆ GetClothFromArea()

proto external IEntity GetClothFromArea ( typename pAreaType )

Get the first cloth entity that satisfies the condition : "slot area type is inherited by pAreaType AND slot has attached entity".

◆ GetEmptySlotForItem()

InventoryStorageSlot GetEmptySlotForItem ( IEntity item )

protected

Usually any slot that item can be inserted to.

Definition at line 17 of file SCR_HandSlotStorageComponent.c.

◆ GetEstimatedCountFitForItem()

proto external int GetEstimatedCountFitForItem ( IEntity item )

protected

Get an estimate of how many times the item can fit in the inventory.

◆ GetEstimatedCountFitForResource()

proto external int GetEstimatedCountFitForResource ( ResourceName resourceName )

protected

Get an estimate of how many times the resource can fit in the inventory.

◆ GetItem()

proto external sealed InventoryItemComponent GetItem ( int slotID )

protected

Get item at slot ID.

Parameters

slotID Slot ID

Returns: Returns the item component of the slot entity or null if slot empty.

◆ GetMaxDimensionCapacity()

proto external vector GetMaxDimensionCapacity ( )

protected

◆ GetMaxVolumeCapacity()

proto external float GetMaxVolumeCapacity ( )

protected

◆ GetOccupiedSpace()

proto external float GetOccupiedSpace ( )

protected

Returns amount of space occupied by attached items.

◆ GetOwnedItems()

proto external void GetOwnedItems	(	out notnull array< InventoryItemComponent >	outItemsComponents,
		bool	includeChildComponents = true )

protected

Fills array with attached items, optionally including items from child storage components.

◆ GetOwnedStorages()

proto external bool GetOwnedStorages	(	out notnull array< BaseInventoryStorageComponent >	outStorages,
		int	depth,
		bool	includeHierarchy )

protected

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)

Parameters

outStorages	- array to be filled with storages
depth	- at what depth level should be storages collected
includeHierarchy	- should storages from upper depth level be included in array

Returns: true if depth was reached

◆ GetPriority()

proto external sealed int GetPriority ( )

protected

Get evaluation priority.

Returns: Priority. Higher value = higher priority.

Definition at line 247 of file SCR_BaseManualCameraComponent.c.

◆ GetPurpose()

proto external sealed EStoragePurpose GetPurpose ( )

protected

◆ GetSlot()

proto external sealed InventoryStorageSlot GetSlot ( int slotID )

protected

Return slot for specified id

Parameters

slotID Slot ID.

Returns: Returns the slot.

◆ GetSlotFromArea()

EquipedLoadoutStorageComponentClass ScriptedBaseInventoryStorageComponentClass GetSlotFromArea ( typename pAreaType )

Get the first slot that satisfies the condition : "slot area type is inherited by pAreaType".

◆ GetSlotsCount()

proto external int GetSlotsCount ( )

protected

Returns the number of slots in this storage.

◆ GetSlotsCountScr()

int GetSlotsCountScr ( )

protected

Should Return slots count.

◆ GetSlotScr()

InventoryStorageSlot GetSlotScr ( int slotID )

protected

Should Return slot for specified id.

◆ GetSlotsFromArea()

proto external int GetSlotsFromArea	(	typename pAreaType	,
		out array< ref LoadoutSlotInfo >	outSlots )

Get the slots that satisfies the condition : "slot area type is inherited by pAreaType".

Parameters

outSlots Array where slots will be added.

Returns: How many elements have been added to the array.

◆ GetWeightFromResource()

proto external float GetWeightFromResource ( ResourceName resourceName )

protected

Get the weight of a prefab.

◆ InsertItem()

ref BaseInventoryTask InsertItem	(	IEntity	item,
		int	slotID,
		bool	justSpawned )

protected

Called locally per instance, implement insertion logics here, Manager will provide slotID of -1 in case slot is irrelevant. justSpawned parameter says that we are inserting the item right after it was spawned and when this is true on server, it usually means that the owner of the slot(f.e. client character) might not have the entity streamed-in when this insertion happens.

◆ IsCompartment()

proto external bool IsCompartment ( )

protected

does current storage serves as a compartment of other storage

◆ OnAddedToSlot()

void OnAddedToSlot	(	IEntity	item,
		int	slotID )

protected

Will be called when item is added to slot. IMPORTANT* This is called after the C++ event.

Definition at line 96 of file SCR_HandSlotStorageComponent.c.

◆ OnManagerChanged()

void OnManagerChanged ( InventoryStorageManagerComponent manager )

protected

Will be called when manager is changed, manager can be null if there is no manager in hierarchy (item drop in world). IMPORTANT* This is called after the C++ event.

Definition at line 236 of file SCR_HandSlotStorageComponent.c.

◆ OnOverrideCanRemoveItem()

event bool OnOverrideCanRemoveItem ( )

protected

It should return true or false depending if the scripter wants to override the behavior of the C++ function or not. IMPORTANT* This should contains one line with return true/false; The result is cached, so this function can't be made dynamic

Definition at line 115 of file BaseInventoryStorageComponent.c.

◆ OnOverrideCanReplaceItem()

event bool OnOverrideCanReplaceItem ( )

protected

It should return true or false depending if the scripter wants to override the behavior of the C++ function or not. IMPORTANT* This should contains one line with return true/false; The result is cached, so this function can't be made dynamic

Definition at line 120 of file BaseInventoryStorageComponent.c.

◆ OnOverrideCanStoreItem()

event bool OnOverrideCanStoreItem ( )

protected

It should return true or false depending if the scripter wants to override the behavior of the C++ function or not. IMPORTANT* This should contains one line with return true/false; The result is cached, so this function can't be made dynamic

Definition at line 105 of file BaseInventoryStorageComponent.c.

◆ OnOverrideCanStoreResource()

event bool OnOverrideCanStoreResource ( )

protected

It should return true or false depending if the scripter wants to override the behavior of the C++ function or not. IMPORTANT* This should contains one line with return true/false; The result is cached, so this function can't be made dynamic

Definition at line 110 of file BaseInventoryStorageComponent.c.

◆ OnRemovedFromSlot()

void OnRemovedFromSlot	(	IEntity	item,
		int	slotID )

protected

Will be called when item is removed from slot IMPORTANT* This is called after the C++ event.

Definition at line 229 of file SCR_HandSlotStorageComponent.c.

◆ PerformDimensionValidation()

proto external bool PerformDimensionValidation ( IEntity item )

protected

Performs dimension validation.

◆ PerformVolumeValidation()

proto external bool PerformVolumeValidation	(	IEntity	item,
		bool	includeDimensionValidation = true )

protected

Performs item volume and (optionally) dimension validation.

◆ PerformVolumeValidationForResource()

proto external bool PerformVolumeValidationForResource	(	ResourceName	resourceName,
		bool	includeDimensionValidation = true )

protected

Performs prefab volume and (optionally) dimension validation.

◆ ReleaseSlotHooks()

void ReleaseSlotHooks ( InventoryStorageSlot ownedSlot )

protected

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)

◆ RemoveItem()

ref BaseInventoryTask RemoveItem ( IEntity item )

protected

Called locally per instance, implement remove logics here.

◆ ResolvePreviewEntityForPrefab()

proto external IEntity ResolvePreviewEntityForPrefab ( ResourceName prefabResource )

◆ SetPreviewItem()

ItemPreviewManagerEntityClass GenericEntityClass SetPreviewItem	(	ItemPreviewWidget	widget,
		IEntity	item,
		PreviewRenderAttributes	attributes = null,
		bool	forceRefresh = false,
		int	maxLifeTimeMS = 30000 )

Set item to preview, optional override for PreviewRenderAttributes and forcing refresh of preview item (usualy not needed since system is taking care of updating hierarchy when entity hierarchy is changed) maxLiftTime sets the maximum time that the item preview can remain in cache after being unused. if maxLifeTimeMS <= 0, the entry will always stay in cache

◆ SetPreviewItemFromPrefab()

proto external void SetPreviewItemFromPrefab	(	ItemPreviewWidget	widget,
		ResourceName	prefabResource,
		PreviewRenderAttributes	attributes = null,
		bool	forceRefresh = false,
		int	maxLifeTimeMS = 30000 )

◆ SetupSlotHooks()

BaseInventoryStorageComponentClass InventoryItemComponentClass SetupSlotHooks	(	InventoryStorageSlot	ownedSlot,
		int	slotID )

IMPORTANT* Should be called upon initialization of slot instance provide newly created slot and desired slot ID

◆ ShouldPreviewAttachedItems()

bool ShouldPreviewAttachedItems ( )

protected

Will be called to estimate if storage children has to be included in preview.

Equipment storage are slots which are part of their parent entity but not taking up the standard cargo space, such as slot for flashlight in the form of a strap on the vest or belt.

Will be called to estimate if storage children has to be included in preview.

Will be called to estimate if storage children has to be included in preview

Definition at line 1 of file SCR_EquipmentStorageComponent.c.

◆ UpdateUI()

void UpdateUI ( )

protected

Virtual method for updating the UI when an item is removed/added.

Definition at line 1 of file ScriptedBaseInventoryStorageComponent.c.

Enumerations
enum	EStoragePurpose { PURPOSE_UNSET , PURPOSE_DEPOSIT , PURPOSE_WEAPON_PROXY , PURPOSE_GADGET_PROXY , PURPOSE_LOADOUT_PROXY , PURPOSE_ATTACHMENT_PROXY , PURPOSE_EQUIPMENT_ATTACHMENT , PURPOSE_ANY , PURPOSE_UNSET , PURPOSE_DEPOSIT , PURPOSE_WEAPON_PROXY , PURPOSE_GADGET_PROXY , PURPOSE_LOADOUT_PROXY , PURPOSE_ATTACHMENT_PROXY , PURPOSE_EQUIPMENT_ATTACHMENT , PURPOSE_ANY }
enum	EStoragePurpose { PURPOSE_UNSET , PURPOSE_DEPOSIT , PURPOSE_WEAPON_PROXY , PURPOSE_GADGET_PROXY , PURPOSE_LOADOUT_PROXY , PURPOSE_ATTACHMENT_PROXY , PURPOSE_EQUIPMENT_ATTACHMENT , PURPOSE_ANY , PURPOSE_UNSET , PURPOSE_DEPOSIT , PURPOSE_WEAPON_PROXY , PURPOSE_GADGET_PROXY , PURPOSE_LOADOUT_PROXY , PURPOSE_ATTACHMENT_PROXY , PURPOSE_EQUIPMENT_ATTACHMENT , PURPOSE_ANY }

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EStoragePurpose [1/2]

◆ EStoragePurpose [2/2]

Function Documentation

◆ CanRemoveItem()

◆ CanReplaceItem()

◆ CanStoreItem()

◆ CanStoreResource()

◆ Contains()

◆ FindItemSlot()

◆ FindSuitableSlotForItem()

◆ Get()

◆ GetAll()

◆ GetClothFromArea()

◆ GetEmptySlotForItem()

◆ GetEstimatedCountFitForItem()

◆ GetEstimatedCountFitForResource()

◆ GetItem()

◆ GetMaxDimensionCapacity()

◆ GetMaxVolumeCapacity()

◆ GetOccupiedSpace()

◆ GetOwnedItems()

◆ GetOwnedStorages()

◆ GetPriority()

◆ GetPurpose()

◆ GetSlot()

◆ GetSlotFromArea()

◆ GetSlotsCount()

◆ GetSlotsCountScr()

◆ GetSlotScr()

◆ GetSlotsFromArea()

◆ GetWeightFromResource()

◆ InsertItem()

◆ IsCompartment()

◆ OnAddedToSlot()

◆ OnManagerChanged()

◆ OnOverrideCanRemoveItem()

◆ OnOverrideCanReplaceItem()

◆ OnOverrideCanStoreItem()

◆ OnOverrideCanStoreResource()

◆ OnRemovedFromSlot()

◆ PerformDimensionValidation()

◆ PerformVolumeValidation()

◆ PerformVolumeValidationForResource()

◆ ReleaseSlotHooks()

◆ RemoveItem()

◆ ResolvePreviewEntityForPrefab()

◆ SetPreviewItem()

◆ SetPreviewItemFromPrefab()

◆ SetupSlotHooks()

◆ ShouldPreviewAttachedItems()

◆ UpdateUI()