Arma Reforger Explorer  1.1.0.42
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
BaseInventoryStorageComponent.c
Go to the documentation of this file.
1 /*
2 ===========================================
3 Do not modify, this script is generated
4 ===========================================
5 */
6 
13 {
14 }
15 
16 class BaseInventoryStorageComponent: InventoryItemComponent
17 {
22  proto external sealed protected void SetupSlotHooks(InventoryStorageSlot ownedSlot, int slotID);
27  proto external sealed protected void ReleaseSlotHooks(InventoryStorageSlot ownedSlot);
33  proto external sealed bool Contains(IEntity item);
39  proto external sealed InventoryStorageSlot FindItemSlot(IEntity item);
41  proto external int GetSlotsCount();
47  proto external sealed InventoryStorageSlot GetSlot(int slotID);
53  proto external sealed IEntity Get(int slotID);
54  // Returns all stored items in this storage
55  proto external sealed int GetAll(out notnull array<IEntity> outItems);
56  // Returns storage priority
57  proto external sealed int GetPriority();
58  proto external sealed EStoragePurpose GetPurpose();
59  // Search for slot where item can be inserted
60  proto external InventoryStorageSlot FindSuitableSlotForItem(IEntity item);
62  proto external float GetOccupiedSpace();
64  proto external bool IsCompartment();
66  proto external void GetOwnedItems(out notnull array<InventoryItemComponent> outItemsComponents);
75  proto external bool GetOwnedStorages(out notnull array<BaseInventoryStorageComponent> outStorages, int depth, bool includeHierarchy);
77  proto external bool PerformVolumeValidation(IEntity item, bool includeDimensionValidation = true);
79  proto external bool PerformDimensionValidation(IEntity item);
80  // convinience method, returns volume calculated from dimension limits
81  proto external float GetMaxVolumeCapacity();
82  // return dimension limits for storage
83  proto external vector GetMaxDimensionCapacity();
85  proto external float GetWeightFromResource(ResourceName resourceName);
87  proto external bool PerformVolumeAndDimensionValidationForResource(ResourceName resourceName, bool includeDimensionValidation = true);
88 
89  // callbacks
90 
95  event bool OnOverrideCanStoreItem() { return false; };
100  event bool OnOverrideCanStoreResource() { return false; };
105  event bool OnOverrideCanRemoveItem() { return false; };
110  event bool OnOverrideCanReplaceItem() { return false; };
115  event protected void OnAddedToSlot(IEntity item, int slotID);
120  event protected void OnRemovedFromSlot(IEntity item, int slotID);
122  event protected InventoryStorageSlot GetEmptySlotForItem(IEntity item);
124  event bool CanStoreItem(IEntity item, int slotID) { return true; };
126  event bool CanStoreResource(ResourceName resourceName, int slotID) { return true; };
128  event bool CanRemoveItem(IEntity item) { return true; };
130  event bool CanReplaceItem(IEntity nextItem, int slotID) { return true; };
132  event protected int GetSlotsCountScr();
134  event protected InventoryStorageSlot GetSlotScr(int slotID);
136  event protected ref BaseInventoryTask RemoveItem(IEntity item);
138  event protected ref BaseInventoryTask InsertItem(IEntity item, int slotID);
140  event protected bool ShouldPreviewAttachedItems();
145  event protected void OnManagerChanged(InventoryStorageManagerComponent manager);
146 }
147 
PerformDimensionValidation
proto external bool PerformDimensionValidation(IEntity item)
performs dimension validation.
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: BaseInventoryStorageComponent.c:124
OnOverrideCanReplaceItem
event bool OnOverrideCanReplaceItem()
Definition: BaseInventoryStorageComponent.c:110
CanReplaceItem
event bool CanReplaceItem(IEntity nextItem, int slotID)
Implemented logics for can replace to nextItem at slotID,.
Definition: BaseInventoryStorageComponent.c:130
InventoryStorageSlot
Definition: InventoryStorageSlot.c:12
GetOwnedItems
proto external void GetOwnedItems(out notnull array< InventoryItemComponent > outItemsComponents)
Fills array with attached items including items from storage compartments.
OnRemovedFromSlot
event protected void OnRemovedFromSlot(IEntity item, int slotID)
Definition: SCR_CharacterInventoryStorageComponent.c:597
OnManagerChanged
event protected void OnManagerChanged(InventoryStorageManagerComponent manager)
Definition: SCR_UniversalInventoryStorageComponent.c:247
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: BaseInventoryStorageComponent.c:126
SetupSlotHooks
BaseInventoryStorageComponentClass InventoryItemComponentClass SetupSlotHooks(InventoryStorageSlot ownedSlot, int slotID)
GetSlotsCount
proto external int GetSlotsCount()
Returns the number of slots in this storage.
OnOverrideCanStoreItem
event bool OnOverrideCanStoreItem()
Definition: BaseInventoryStorageComponent.c:95
GetSlotsCountScr
event protected int GetSlotsCountScr()
Should Return slots count.
InventoryItemComponentClass
Definition: InventoryItemComponentClass.c:12
GetPriority
proto external sealed int GetPriority()
Definition: SCR_BaseManualCameraComponent.c:107
ReleaseSlotHooks
proto external sealed protected void ReleaseSlotHooks(InventoryStorageSlot ownedSlot)
IsCompartment
proto external bool IsCompartment()
does current storage serves as a compartment of other storage
BaseInventoryTask
Definition: BaseInventoryTask.c:12
CanRemoveItem
event bool CanRemoveItem(IEntity item)
Implemented logics for can remove here,.
Definition: BaseInventoryStorageComponent.c:128
FindSuitableSlotForItem
proto external InventoryStorageSlot FindSuitableSlotForItem(IEntity item)
InventoryStorageManagerComponent
Definition: InventoryStorageManagerComponent.c:12
GetSlotScr
event protected InventoryStorageSlot GetSlotScr(int slotID)
Should Return slot for specified id.
OnAddedToSlot
event protected void OnAddedToSlot(IEntity item, int slotID)
Definition: SCR_CharacterInventoryStorageComponent.c:563
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 ca...
FindItemSlot
proto external sealed InventoryStorageSlot FindItemSlot(IEntity item)
RemoveItem
event protected ref BaseInventoryTask RemoveItem(IEntity item)
Called locally per instance, implement remove logics here.
OnOverrideCanStoreResource
event bool OnOverrideCanStoreResource()
Definition: BaseInventoryStorageComponent.c:100
ShouldPreviewAttachedItems
event protected bool ShouldPreviewAttachedItems()
Will be called to estimate if storage children has to be included in preview.
Definition: SCR_EquipmentStorageComponent.c:10
GetAll
proto external sealed int GetAll(out notnull array< IEntity > outItems)
PerformVolumeValidation
proto external bool PerformVolumeValidation(IEntity item, bool includeDimensionValidation=true)
performs volume and item dimension validation.
Contains
proto external sealed bool Contains(IEntity item)
InventoryItemComponent
Definition: InventoryItemComponent.c:12
Get
proto external sealed IEntity Get(int slotID)
BaseInventoryStorageComponentClass
Definition: BaseInventoryStorageComponent.c:12
OnOverrideCanRemoveItem
event bool OnOverrideCanRemoveItem()
Definition: BaseInventoryStorageComponent.c:105
EStoragePurpose
EStoragePurpose
Definition: EStoragePurpose.c:12
GetSlot
proto external sealed InventoryStorageSlot GetSlot(int slotID)
PerformVolumeAndDimensionValidationForResource
proto external bool PerformVolumeAndDimensionValidationForResource(ResourceName resourceName, bool includeDimensionValidation=true)
performs volume and item dimension validation.
GetWeightFromResource
proto external float GetWeightFromResource(ResourceName resourceName)
get the weight of a prefab
GetOccupiedSpace
proto external float GetOccupiedSpace()
returns amount of space occupied by attached items
GetEmptySlotForItem
event protected InventoryStorageSlot GetEmptySlotForItem(IEntity item)
Usually any slot that item can be inserted to.
GetMaxVolumeCapacity
proto external float GetMaxVolumeCapacity()
GetMaxDimensionCapacity
proto external vector GetMaxDimensionCapacity()
GetOwnedStorages
proto external bool GetOwnedStorages(out notnull array< BaseInventoryStorageComponent > outStorages, int depth, bool includeHierarchy)
GetPurpose
proto external sealed EStoragePurpose GetPurpose()