Data Structures
class	AimingModifierAttributes

class	AttachmentAttributes

class	AttachmentsStorageComponentClass

class	BaseEquipedWeaponStorageComponentClass

class	BaseEquipmentStorageComponentClass

class	BaseInventoryStorageComponentClass

class	BaseItemAttributeData

class	BaseUniversalInventoryStorageComponentClass

class	CharacterInventoryStorageComponentClass

class	CharacterModifierAttributes

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)

proto external sealed protected 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. More...

proto external sealed InventoryStorageSlot	GetSlot (int slotID)

proto external sealed IEntity	Get (int slotID)

proto external sealed int	GetAll (out notnull array< IEntity > outItems)

proto external sealed int	GetPriority ()

proto external sealed EStoragePurpose	GetPurpose ()

proto external InventoryStorageSlot	FindSuitableSlotForItem (IEntity item)

proto external float	GetOccupiedSpace ()
	returns amount of space occupied by attached items More...

proto external bool	IsCompartment ()
	does current storage serves as a compartment of other storage More...

proto external void	GetOwnedItems (out notnull array< InventoryItemComponent > outItemsComponents)
	Fills array with attached items including items from storage compartments. More...

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

proto external bool	PerformVolumeValidation (IEntity item, bool includeDimensionValidation=true)
	performs volume and item dimension validation. More...

proto external bool	PerformDimensionValidation (IEntity item)
	performs dimension validation. More...

proto external float	GetMaxVolumeCapacity ()

proto external vector	GetMaxDimensionCapacity ()

proto external float	GetWeightFromResource (ResourceName resourceName)
	get the weight of a prefab More...

proto external bool	PerformVolumeAndDimensionValidationForResource (ResourceName resourceName, bool includeDimensionValidation=true)
	performs volume and item dimension validation. More...

event bool	OnOverrideCanStoreItem ()

event bool	OnOverrideCanStoreResource ()

event bool	OnOverrideCanRemoveItem ()

event bool	OnOverrideCanReplaceItem ()

event protected void	OnAddedToSlot (IEntity item, int slotID)

event protected void	OnRemovedFromSlot (IEntity item, int slotID)

event protected InventoryStorageSlot	GetEmptySlotForItem (IEntity item)
	Usually any slot that item can be inserted to. More...

event bool	CanStoreItem (IEntity item, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant. More...

event bool	CanStoreResource (ResourceName resourceName, int slotID)
	Implemented logics for can insert here, Manager will provide slotID of -1 in case slot is irrelevant. More...

event bool	CanRemoveItem (IEntity item)
	Implemented logics for can remove here,. More...

event bool	CanReplaceItem (IEntity nextItem, int slotID)
	Implemented logics for can replace to nextItem at slotID,. More...

event protected int	GetSlotsCountScr ()
	Should Return slots count. More...

event protected InventoryStorageSlot	GetSlotScr (int slotID)
	Should Return slot for specified id. More...

event protected ref BaseInventoryTask	RemoveItem (IEntity item)
	Called locally per instance, implement remove logics here. More...

event protected 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. More...

event protected bool	ShouldPreviewAttachedItems ()
	Will be called to estimate if storage children has to be included in preview. More...

event protected void	OnManagerChanged (InventoryStorageManagerComponent manager)

CharacterVicinityComponentClass GameComponentClass	GetAvailableItems (inout notnull array< IEntity > items)

proto external void	SetItemOfInterest (IEntity item)

proto external void	ManipulationComplete ()

proto external IEntity	GetItemOfInterest ()

proto external float	GetDiscoveryRadius ()

event protected void	OnUpdate ()

EquipedLoadoutStorageComponentClass ScriptedBaseInventoryStorageComponentClass	GetSlotFromArea (typename pAreaType)
	Get the first slot that satisfies the condition : "slot area type is inherited by pAreaType". More...

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". More...

ItemPreviewManagerEntityClass GenericEntityClass	SetPreviewItem (ItemPreviewWidget widget, IEntity item, PreviewRenderAttributes attributes=null, bool forceRefresh=false)
	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) More...

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

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 )

Implemented logics for can remove here,.

Definition at line 128 of file BaseInventoryStorageComponent.c.

◆ CanReplaceItem()

event bool CanReplaceItem	(	IEntity	nextItem,
		int	slotID
	)

Implemented logics for can replace to nextItem at slotID,.

Definition at line 130 of file BaseInventoryStorageComponent.c.

◆ CanStoreItem()

event bool CanStoreItem	(	IEntity	item,
		int	slotID
	)

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

Definition at line 124 of file BaseInventoryStorageComponent.c.

◆ CanStoreResource()

event bool CanStoreResource	(	ResourceName	resourceName,
		int	slotID
	)

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

Definition at line 126 of file BaseInventoryStorageComponent.c.

◆ Contains()

proto external sealed bool Contains ( IEntity item )

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 )

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 )

◆ Get()

proto external sealed IEntity Get ( int slotID )

Get item at slot ID.

Parameters

slotID Slot ID

Returns: Returns the item.

◆ GetAll()

proto external sealed int GetAll ( out notnull array< IEntity > outItems )

◆ GetAvailableItems()

CharacterVicinityComponentClass GameComponentClass GetAvailableItems ( inout notnull array< IEntity > items )

IMPORTANT ***

Call ManipulationComplete method as soon as you are done working with items from the vicinity

Parameters

items Array which need to be filled.

◆ 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".

◆ GetDiscoveryRadius()

proto external float GetDiscoveryRadius ( )

◆ GetEmptySlotForItem()

event protected InventoryStorageSlot GetEmptySlotForItem ( IEntity item )

Usually any slot that item can be inserted to.

◆ GetItemOfInterest()

proto external IEntity GetItemOfInterest ( )

◆ GetMaxDimensionCapacity()

proto external vector GetMaxDimensionCapacity ( )

◆ GetMaxVolumeCapacity()

proto external float GetMaxVolumeCapacity ( )

◆ GetOccupiedSpace()

proto external float GetOccupiedSpace ( )

returns amount of space occupied by attached items

◆ GetOwnedItems()

proto external void GetOwnedItems ( out notnull array< InventoryItemComponent > outItemsComponents )

Fills array with attached items including items from storage compartments.

◆ GetOwnedStorages()

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)

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 ( )

Get evaluation priority.

Returns: Priority. Higher value = higher priority.

Definition at line 107 of file SCR_BaseManualCameraComponent.c.

◆ GetPurpose()

proto external sealed EStoragePurpose GetPurpose ( )

◆ GetSlot()

proto external sealed InventoryStorageSlot GetSlot ( int slotID )

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 ( )

Returns the number of slots in this storage.

◆ GetSlotsCountScr()

event protected int GetSlotsCountScr ( )

Should Return slots count.

◆ GetSlotScr()

event protected InventoryStorageSlot GetSlotScr ( int slotID )

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 )

get the weight of a prefab

◆ InsertItem()

event protected 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.

◆ IsCompartment()

proto external bool IsCompartment ( )

does current storage serves as a compartment of other storage

◆ ManipulationComplete()

proto external void ManipulationComplete ( )

◆ OnAddedToSlot()

event protected void OnAddedToSlot	(	IEntity	item,
		int	slotID
	)

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

Called when item is added to slot, update armored attributes when item with armorData is equipped

Parameters

[in]	item
[in]	slotID

Definition at line 563 of file SCR_CharacterInventoryStorageComponent.c.

◆ OnManagerChanged()

event protected 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). IMPORTANT* This is called after the C++ event.

Definition at line 247 of file SCR_UniversalInventoryStorageComponent.c.

◆ OnOverrideCanRemoveItem()

event bool OnOverrideCanRemoveItem ( )

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.

◆ OnOverrideCanReplaceItem()

event bool OnOverrideCanReplaceItem ( )

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.

◆ OnOverrideCanStoreItem()

event bool OnOverrideCanStoreItem ( )

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 95 of file BaseInventoryStorageComponent.c.

◆ OnOverrideCanStoreResource()

event bool OnOverrideCanStoreResource ( )

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 100 of file BaseInventoryStorageComponent.c.

◆ OnRemovedFromSlot()

event protected void OnRemovedFromSlot	(	IEntity	item,
		int	slotID
	)

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

Definition at line 597 of file SCR_CharacterInventoryStorageComponent.c.

◆ OnUpdate()

event protected void OnUpdate ( )

Definition at line 237 of file SCR_MapMarkerSquadLeader.c.

◆ PerformDimensionValidation()

proto external bool PerformDimensionValidation ( IEntity item )

performs dimension validation.

◆ PerformVolumeAndDimensionValidationForResource()

proto external bool PerformVolumeAndDimensionValidationForResource	(	ResourceName	resourceName,
		bool	includeDimensionValidation = `true`
	)

performs volume and item dimension validation.

◆ PerformVolumeValidation()

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

performs volume and item dimension validation.

◆ ReleaseSlotHooks()

proto external sealed protected 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)

◆ RemoveItem()

event protected ref BaseInventoryTask RemoveItem ( IEntity item )

Called locally per instance, implement remove logics here.

◆ ResolvePreviewEntityForPrefab()

proto external IEntity ResolvePreviewEntityForPrefab ( ResourceName prefabResource )

◆ SetItemOfInterest()

proto external void SetItemOfInterest ( IEntity item )

◆ SetPreviewItem()

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

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)

◆ SetPreviewItemFromPrefab()

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

◆ 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()

event protected bool ShouldPreviewAttachedItems ( )

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 10 of file SCR_EquipmentStorageComponent.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 }

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EStoragePurpose [1/2]

◆ EStoragePurpose [2/2]

Function Documentation

◆ CanRemoveItem()

◆ CanReplaceItem()

◆ CanStoreItem()

◆ CanStoreResource()

◆ Contains()

◆ FindItemSlot()

◆ FindSuitableSlotForItem()

◆ Get()

◆ GetAll()

◆ GetAvailableItems()

◆ GetClothFromArea()

◆ GetDiscoveryRadius()

◆ GetEmptySlotForItem()

◆ GetItemOfInterest()

◆ GetMaxDimensionCapacity()

◆ GetMaxVolumeCapacity()

◆ GetOccupiedSpace()

◆ GetOwnedItems()

◆ GetOwnedStorages()

◆ GetPriority()

◆ GetPurpose()

◆ GetSlot()

◆ GetSlotFromArea()

◆ GetSlotsCount()

◆ GetSlotsCountScr()

◆ GetSlotScr()

◆ GetSlotsFromArea()

◆ GetWeightFromResource()

◆ InsertItem()

◆ IsCompartment()

◆ ManipulationComplete()

◆ OnAddedToSlot()

◆ OnManagerChanged()

◆ OnOverrideCanRemoveItem()

◆ OnOverrideCanReplaceItem()

◆ OnOverrideCanStoreItem()

◆ OnOverrideCanStoreResource()

◆ OnRemovedFromSlot()

◆ OnUpdate()

◆ PerformDimensionValidation()

◆ PerformVolumeAndDimensionValidationForResource()

◆ PerformVolumeValidation()

◆ ReleaseSlotHooks()

◆ RemoveItem()

◆ ResolvePreviewEntityForPrefab()

◆ SetItemOfInterest()

◆ SetPreviewItem()

◆ SetPreviewItemFromPrefab()

◆ SetupSlotHooks()

◆ ShouldPreviewAttachedItems()