Function UnitAddItemToSlotById

  • Creates a new item of type itemId and puts it in unit's inventory in slot specified by itemSlot. If the slot is occupied or invalid (<0 or >6, or higher than unit's max slots), it is dropped on the ground at unit's position instead.

    This function works in two steps:

    1. Spawn the item if both whichUnit and itemId are valid and exist
    2. Attempt to put the item in unit's inventory at specified slot. If the slot is occupied or unit is dead then the item is dropped on the ground at unit position.

    Returns:

    • true if the item was successfully placed in unit's inventory
    • false otherwise: slot occupied, unit cannot carry items, itemId/unit/itemSlot invalid etc.

    Parameters

    • whichUnit: Unit<UnitEventMap>

      Target unit.

    • itemId: number

      Item's raw code identifier.

    • itemSlot: number

      Slot number (zero-based, i.e. 0 to 5).

    Returns boolean

    Note

    See: UnitAddItemById.

Generated using TypeDoc