Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
EquipedLoadoutStorageComponent Interface Reference
Inheritance diagram for EquipedLoadoutStorageComponent:
[legend]

Public Member Functions

proto external LoadoutSlotInfo 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)
 Get the slots that satisfies the condition : "slot area type is inherited by pAreaType".
 
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".
 
- Public Member Functions inherited from BaseInventoryStorageComponent
proto external sealed bool Contains (IEntity item)
 Check if an item is inside this storage.
 
proto external sealed InventoryStorageSlot FindItemSlot (IEntity item)
 Find the item slot.
 
proto external int GetSlotsCount ()
 Returns the number of slots in this storage.
 
proto external sealed InventoryStorageSlot GetSlot (int slotID)
 Return slot for specified id.
 
proto external sealed IEntity Get (int slotID)
 Get item at slot ID.
 
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
 
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 bool PerformVolumeValidation (IEntity item, bool includeDimensionValidation=true)
 performs volume and item dimension validation.
 
proto external bool PerformDimensionValidation (IEntity item)
 performs dimension validation.
 
proto external float GetMaxVolumeCapacity ()
 
proto external vector GetMaxDimensionCapacity ()
 
proto external int GetEstimatedCountFitForItem (IEntity item)
 get a rough estimate of how many times the item can fit in the inventory
 
proto external float GetWeightFromResource (ResourceName resourceName, int count=1)
 get the weight of a prefab
 
proto external int GetEstimatedCountFitForResource (ResourceName resourceName)
 get a rough estimate of how many times the resource can fit in the inventory
 
proto external bool PerformVolumeAndDimensionValidationForResource (ResourceName resourceName, bool includeDimensionValidation=true, int count=1)
 performs volume and item dimension validation.
 
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, int count)
 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 ()
 

Additional Inherited Members

- Public Attributes inherited from InventoryItemComponent
ref ScriptInvoker< bool > m_OnLockedStateChangedInvoker = new ScriptInvoker<bool>()
 
ref ScriptInvoker< InventoryStorageSlot, InventoryStorageSlotm_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 sealed 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 sealed 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).
 
void UpdateUI ()
 Virtual method for updating the UI when an item is removed/added.
 
- Protected Member Functions inherited from InventoryItemComponent
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.
 

Member Function Documentation

◆ GetClothFromArea()

proto external IEntity EquipedLoadoutStorageComponent.GetClothFromArea ( TypeName  pAreaType)

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

◆ GetSlotFromArea()

proto external LoadoutSlotInfo EquipedLoadoutStorageComponent.GetSlotFromArea ( TypeName  pAreaType)

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

◆ GetSlotsFromArea()

proto external int EquipedLoadoutStorageComponent.GetSlotsFromArea ( TypeName  pAreaType,
out array< ref LoadoutSlotInfo outSlots 
)

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

Parameters
outSlotsArray where slots will be added.
Returns
How many elements have been added to the array.

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