Exports & Commands#

Every upstream ox_inventory export, event, callback and hook keeps working. This page lists what Koja adds, how it changes upstream behaviour, and every command and keybind.

New server exports#

getClothing#

Returns the clothing a player wears.

local state = exports.ox_inventory:getClothing(source)

{
    enabled = true,
    gender = 'male',
    slots = {
        {
            key = 'torso', label = 'Torso', icon = 'layers', column = 'left',
            kind = 'component', id = 11,
            item = { name = 'clothing', slot = 7, metadata = { ... }, ... }, -- nil when empty
            wear = { drawable = 4, texture = 0, ... },                        -- what the ped wears
        },
        -- one entry per slot of clothing.slots
    },
}

IsSlotLocked#

true when the slot exists but needs a backpack.

if exports.ox_inventory:IsSlotLocked(source, slot) then
    -- do not put anything here
end

The first argument is anything exports.ox_inventory:GetInventory accepts (player id or inventory).

New client exports#

-- open a trade with the closest player, offering slot 3
exports.ox_inventory:requestTrade(nil, 3)

-- undress the player
exports.ox_inventory:fastAction('undress')

Upstream exports#

All exports of ox_inventory 2.48.0 are unchanged. The ones you use most:

Server: AddItem, RemoveItem, CanCarryItem, CanCarryAmount, CanCarryWeight, CanSwapItem, GetItem, GetItemCount, Search, GetSlot, GetSlotWithItem, GetSlotIdWithItem, GetSlotsWithItem, GetSlotIdsWithItem, GetEmptySlot, GetSlotForItem, SetMetadata, SetDurability, SetSlotCount, SetItem, SetMaxWeight, GetInventory, GetInventoryItems, GetInventories, GetContainerFromSlot, GetCurrentWeapon, RegisterStash, CreateTemporaryStash, RegisterShop, CustomDrop, CreateDropFromPlayer, ClearInventory, ConfiscateInventory, ReturnInventory, RemoveInventory, UpdateVehicle, SwapSlots, InspectInventory, forceOpenInventory, setPlayerInventory, registerHook, removeHooks, Items, ItemList, setContainerProperties.

Client: openInventory, closeInventory, openNearbyInventory, useItem, useSlot, getCurrentWeapon, setStashTarget, giveItemToTarget, Search, GetItemCount, GetPlayerItems, GetPlayerWeight, GetPlayerMaxWeight, GetSlotWithItem, GetSlotIdWithItem, GetSlotsWithItem, displayMetadata, notify, suppressItemNotifications, weaponWheel, setGetPlayerNameMethod, Items, ItemList, Keyboard, Progress, CancelProgress, ProgressActive.

See the ox_inventory documentation for their arguments.

What behaves differently#

Events Koja listens to#

Commands#

Keybinds#

All keybinds can be rebound by players in Settings → Key Bindings → FiveM. The default only applies to players who never changed it.

While aiming a thrown item: left mouse throws, right mouse cancels (throw.keys).