class GameInventorySource

Returns: entity associated with this inventory

dump out failed inventory operations of the current inventory

dump out a more global list of failed inventory operations

query inventory if item is somewhere

All available inventory locations (hands, cargo, attachments, proxycargo, ...) are traversed recursively from root to leafs.

in item

item to be found in inventory

Returns: true if found, false otherwise

enumerate inventory using traversal type and filling items array

in tt

used traversal type

out items

items in inventory (in order determined by traversal)

Returns: true if found any, false otherwise

almost identical to EnumerateInventory except it does not return items

Returns: number of items

Create Entity of specified type in cargo of entity

Create Entity of specified type in cargo of entity at coordinates (row, col)

typeName

type to create

row

the row of cargo to be created at

col

the column of cargo to be created at

index

index into array of configured slots (@see GetSlotIdCount)

Returns: slot where this item belongs

Returns: number of slots this item can belong to

index

index of the slot for attachment (@see GetAttachmentSlotsCount)

Returns: slot for attachment

Returns: number of slots for attachments

Returns: true if this entity has attachments slot with id=slotId

Returns: true if this entity has inventory slot with id=slotId

Returns count of attachments attached to this item

Create Entity of specified type as attachment of entity

Create Entity of specified type as attachment of entity

typeName

type to create

slotId

the slot to be created in

Returns: attached entity by attachment index @NOTE: index is not slot! for getting attachment by slot use FindAttachment

Returns attached entity in slot (you can use InventorySlots.GetSlotIdFromString(name) to get slot id)

Returns attached entity in slot (you can use EntityAI.GetActionComponentName to get slot id)

brief Returns True if entity is attached to this

brief Returns True if entity is attached to this in slot

Check if attachment can be added to any slot

Returns: true if entity can be added as attachment

Check if attachment can be added to slot @NOTE: Note that slot index IS NOT slot ID! Slot ID is defined in DZ/data/config.cpp

Returns placeholder entity for slot (naked arms, legs etc)

returns information about current item location

out loc

current InventoryLocation

Returns: true if current location retrieved (and is valid)

FindFreeLocationFor

in item

item that would be placed in inventory

out loc

the InventoryLocation the item can be placed to

Returns: true if found any, false otherwise

FindFreeLocationForEx

in item

item that would be placed in inventory

out loc

the InventoryLocation the item can be placed to

Returns: true if found any, false otherwise

FindFirstFreeLocationForNewEntity

in item_type

item type that would be placed in inventory

out loc

the InventoryLocation the item can be placed to

Returns: true if found any, false otherwise

searches inventory for suitable location for @item

Example:

in item

item that would be placed in inventory

in flags

flags affecting selection ( @see FindInventoryLocation )

out locs

array of InventoryLocations the item can be placed to

Returns: number of suitable inventory locations

Entity bino = g_Game.CreateObject("Binoculars", "3312 0 854");
EntityAI bino2;
if (Class.CastTo(bino2, bino))
{
  array<ref InventoryLocation> a = new array<ref InventoryLocation>; // 1) allocate memory for array
  for (int i = 0; i < 10; ++i)
  {
    a.Insert(new InventoryLocation); // 2) pre-allocate inventorylocations from script. engine only fills them in, engine does not allocate memory to avoid mixing.
  }

  int sz = player.FindFreeLocationsFor(bino, FindInventoryLocationType.ANY_CARGO | FindInventoryLocationType.ATTACHMENT, a); // 3) ask engine to fill the locations
  if (sz > 0)
  {
    InventoryLocation src = new InventoryLocation;
    bino2.GetCurrentInventoryLocation(src); // 5) get current location

    InventoryLocation dst = a[0]; // 6) get first (this is only example)

    ... use src and dst
  }
}

creates new item directly at location

in type

item type to be placed in inventory

Returns: created entity, null otherwise

creates new <b>local</b> item directly at location @NOTE: the item is created localy, i.e. it's not registered to network

in type

item type to be placed in inventory

Returns: created entity, null otherwise

queries if the entity contained in inv_loc.m_item can be added to ground/attachment/cargo/hands/...

Returns: true if can be added, false otherwise

test if the entity contained in inv_loc.m_item can be added to ground/attachment/cargo/hands/...

Returns: true if can be added, false otherwise

queries if the entity contained in inv_loc.m_item can be removed from ground/attachment/cargo/hands/...

Returns: true if can be added, false otherwise

queries if the entity contained in inv_loc.m_item can be moved to another location This is a shorthand for CanRemove + CanAdd query

Returns: true if can be moved, false otherwise

query the entity at the specific inventory location

Returns: entity at the location, null otherwise

Returns true if this Inventory owner is in cargo of something

Returns true if this Inventory owner is an attachment of something

Returns true if inventory owner or his hiearchy parents are in cargo

Returns true if item is considered reachable within inventory

Returns true if the item is currently attached and outputs attachment slot id and name

adds item to inventory location

Returns: true if success, false otherwise

removes item from inventory location

Returns: true if success, false otherwise

removes item from current inventory location and adds it to destination

Returns: true if success, false otherwise

synchronously removes item from current inventory location and adds it to destination no anims involved

Returns: true if success, false otherwise

swaps two entities

Returns: true if success, false otherwise

removes item from current inventory location and adds it to destination + sync via inventory command

Returns: true if success, false otherwise

synchronously removes item from current inventory location and adds it to destination + sync via inventory command no anims involved

Returns: true if success, false otherwise

swaps two entities

Returns: true if success, false otherwise

hand event to clients

Returns: true if success, false otherwise

Finds a transformation for the item to be dropped to If the initial transforation overlaps with another conflicting entity (i.e. car) then the transform will be snapped to the nearest outer edge. If no valid snapping transformation could be found, then the output from 'PlaceOnSurface' is used

useValuesInMatrix

Is ignored if transformation overlaps with possible conflicting entity. If no valid transform is found and this is false then the transform at the owner is used for 'PlaceOnSurface'

conflictCheckDepth

If -1 then no conflict depth check is performed, if 0 then it only checks to see if it conflicts but doesn't perform snapping

Returns: true if valid transformation found near owner

test if ordinary swap can be performed.

Ordinary in the sense that the two items has equal sizes and can be swapped without additional space.

[in] item1 first item

[in] item2 second item

Returns: true if can be swapped

test if forced swap can be performed.

[in] item1 is the forced item (primary)

[in] item1_dst optional destination for item1 (null if item1 goes to place of item2)

[in] item2 second item that will be replaced by the item1. (secondary)

[out] item2_dst second item's potential destination (if null, search for item_dst2 is ommited). if (NOT null AND IsValid()), then it is tried first, without search to inventory

Returns: true if can be force swapped

Internally: HasInventoryReservationEx(item, dst, FindInventoryReservationMode.LEGACY, FindInventoryReservationMode.LEGACY)

Internally: !HasInventoryReservationEx(item, dst, FindInventoryReservationMode.ITEM, FindInventoryReservationMode.DST)

itemMode will iterate over item reservations, parentMode will iterate over parent reservations

called by engine right after creation of entity

db load hooks

db store hook

creates entity somewhere in inventory

in type

item type to be placed in inventory

Returns: created entity or null

ask inventory if item could be placed somewhere in inventory

All available inventory locations (hands, cargo, attachments, proxycargo, ...) are traversed recursively from root to leafs.

in item

item to be placed in inventory

Returns: true if item can be added, false otherwise

add entity somewhere in inventory

All available inventory locations (hands, cargo, attachments, proxycargo, ...) are traversed recursively from root to leafs.

@NOTE: AddEntityToInventory does not perform the checks the CanAddEntityToInventory does (script conditions for example). if not sure, always call CanAddEntityToInventory before AddEntityToInventory.

in item

item to be placed in inventory

Returns: true if item can be added, false otherwise

Returns if entity can be removed from its current location

Asks inventory if item could be placed in inventory, hands, etc.

Location is based on the flags parameter. This method is used in methods that are asking for if item can be placed in specific location, like CanAddEntityToInventory, CanAddEntityInHands, etc.

in item

item to be placed in inventory

in flags

FindInventoryLocationType

Returns: true if item can be added, false otherwise

Test if entity can be put to the inventory (Cargo, ProxyCargo, Attachment)

Test if entity can be put into hands

Put item anywhere into this entity (as attachment or into cargo, recursively)

@NOTE: Predictive.* / Local.* functions: a) 'Predictive' means that the operation uses Client-Side Prediction, i.e. the action runs the same code on both, client AND server.

b) 'Local' operation executes from where it is run, i.e. the operation from client is NOT sent to server, and only client performs the inventory operation (TakeEntityTo.*) this behaviour is necessary when inventory operations are ALREADY synchronized by another means, like Actions. For example @see ActionTakeItemToHands that performs OnCompleteServer and OnCompleteClient with synchronization set to false in order to avoid duplicate synchronization.

in mode

inventory mode

in flags

preferred location, @see FindInventoryLocationType

in item

item to be taken in inventory

Returns: true on success

helper that finds location first, then moves the entity into it

move src to dst

in mode

inventory mode

in src

source location of the item

in dst

destination location of the item

moves item to cargo of this intentory

in mode

inventory mode

in item

item to be put in this inventory as cargo

Put item into into cargo of another entity

moves item on specific cargo location

in mode

inventory mode

in item

item to be put in this inventory as cargo

Put item into into cargo on specific cargo location of another entity

put item as attachment of target

helper function for swap

helper function for swap

helper function for ForceSwap