The item that is currently active (deployed), or null when nothing is held. Setting this is host authoritative - use Sandbox.InventoryComponent.Switch(Sandbox.BaseInventoryItem,System.Boolean).

Switch away from the active item when it's spent (Sandbox.BaseInventoryItem.ShouldAvoid) and something that isn't is available - the classic arena-shooter auto-switch. Voluntary, so the item can still refuse the holster.

Switch to a picked up item when it's better than the active one (see Sandbox.InventoryComponent.ShouldAutoSwitchTo(Sandbox.BaseInventoryItem)). Empty hands always deploy the pickup.

How this inventory assigns its slots - exclusive hotbar slots or shared buckets.

Grant the loadout automatically when the inventory starts. Turn off to decide when yourself (respawn logic, saved loadouts) and call Sandbox.InventoryComponent.GiveLoadout.

All items currently in the inventory, ordered by slot then Sandbox.BaseInventoryItem.SlotOrder. Includes disabled (inactive) items but not ones waiting to be destroyed - a removed item is gone immediately, even though its GameObject lives until the end of the frame. Items inside a nested inventory (a held backpack) belong to that inventory, not this one.

By default the inventory pumps the active item's control every frame in its own update. Turn this on to take over that timing yourself - the inventory will stop pumping and you call Sandbox.InventoryComponent.Pump from wherever you want (e.g. alongside your player's own input handling).

How many slots this inventory has. Items occupy slots 0..MaxSlots-1.

How this inventory takes items lying in the world - dropped, or placed in the scene.

How close a world item has to be for Touch pickup, from the inventory's origin.

Reserve ammo granted by the loadout.

Item prefabs granted by the loadout, in order. Each needs a Sandbox.BaseInventoryItem.

Does this inventory start with a loadout?

Adds an already-spawned item to the inventory. Slot -1 picks one: the item's Sandbox.BaseInventoryItem.PreferredSlot when free, otherwise the first empty slot (buckets always take the preference). Host only. The item is reparented under this inventory and disabled until switched to.

Is this an item lying in the world that we could take right now? It's valid, it isn't in an inventory, it doesn't refuse us (Sandbox.BaseInventoryItem.OnCanPickup(Sandbox.InventoryComponent)), and it isn't something we dropped a moment ago. Runs on the host for routed pickup requests, making it the place to validate them - the base deliberately has no range check (like shot claims, what's plausible is game policy), so override to add range or line-of-sight rules.

Drops an item out of the inventory and into the world. Holsters it first if it's active, asks the item to place itself (see Sandbox.BaseInventoryItem.Drop), then switches to the best remaining item. Routed through the host.

Returns the first empty slot index, or -1 if the inventory is full.

Holsters the active item without giving it a say (Sandbox.BaseInventoryItem.OnHolstering(Sandbox.BaseInventoryItem) isn't consulted) - for host-decreed empty hands: arrests, vehicles, cutscenes. Host only.

How much reserve ammo of the given type this inventory holds. Null is 0.

Returns the highest Sandbox.BaseInventoryItem.Value item we're allowed to switch to, or null if there's nothing switchable. Items flagged Sandbox.BaseInventoryItem.ShouldAvoid (e.g. empty guns) are only picked when nothing better exists. Override for game-specific priority - runs on the host for engine-driven switches (remove, drop, pickup, loadout), so per-player preference data must be host-available.

Returns the first item of the given type in the inventory (lowest slot wins), or null.

Returns the item in the given slot, or null if the slot is empty. When items share the slot (a buckets inventory), the lowest Sandbox.BaseInventoryItem.SlotOrder wins.

Returns every item in the given slot, ordered by Sandbox.BaseInventoryItem.SlotOrder. One or none in a hotbar inventory; the bucket's contents in a buckets one.

Add reserve ammo of the given type, clamped to the type's Sandbox.AmmoResource.MaxReserve. Returns how much was actually added. Call this from host game logic (pickups) - it's authoritative on the host.

Grants the starting loadout - picks up every Sandbox.InventoryComponent.StartingItems prefab, grants the Sandbox.InventoryComponent.StartingAmmo, then switches to the best item if nothing is active. Host only. Grants unconditionally - it's the caller's job to only ask once per life.

Does this inventory hold at least reserve ammo of the given type?

Returns whether the inventory contains an item of the given type.

Moves the item in to , swapping if the destination is occupied. Routed through the host.

An item is about to be added to . Return false to refuse.

An item is about to be dropped into the world. Return false to refuse.

An item was added to the inventory.

The items in these slots are about to move/swap. Return false to refuse.

An item is about to be removed and destroyed. Return false to refuse.

Spawns an item from a prefab and adds it to the inventory in the given slot (-1 picks one, see Sandbox.InventoryComponent.Add(Sandbox.BaseInventoryItem,System.Int32)). Host only. Returns the spawned item, or null if it couldn't be added (no room, no Sandbox.BaseInventoryItem on the prefab, slot taken).

Take an item lying in the world into this inventory - the path Touch and Use pickup share, and the one to call from game code in None mode. Routed through the host. Refuses anything Sandbox.InventoryComponent.CanPickupWorldItem(Sandbox.BaseInventoryItem) does. The usual add hooks apply, and the item becomes active when nothing else is. Override to change what a pickup does (ammo from duplicates, notices).

Drives the active item's per-frame control hook. The inventory calls this itself every frame unless Sandbox.InventoryComponent.ManualPumping is set, in which case you call it yourself. Only does anything on the client that owns the inventory - control is input, which is owner only.

Removes an item from the inventory and destroys it, then switches to the best remaining item. Routed through the host.

Set the reserve ammo of the given type to an exact value (clamped to zero). Ignores the type's max - the escape hatch for game logic that wants to exceed it.

Should picking this item up make it active? Base: Sandbox.InventoryComponent.AutoSwitchOnPickup is on, the item is better (higher Value) than the active one, and it isn't avoided (an empty gun). The active item can still refuse the holster. Override for game policy.

Makes the given item active, holstering whatever was active. Pass null with to holster everything. Routed through the host.

Switches to the best available item (see Sandbox.InventoryComponent.GetBestItem).

Take up to reserve ammo of the given type, returning how much was actually removed. The owning client spends locally and the spend is mirrored to the host, whose pool is the truth.

Moves an item from this inventory into another - no world drop, no destroy. The usual gates get a say (Sandbox.InventoryComponent.OnRemoving(Sandbox.BaseInventoryItem) here, Sandbox.InventoryComponent.OnAdding(Sandbox.BaseInventoryItem,System.Int32) and the item's own say there); any refusal leaves everything as it was. Reserve ammo stays behind - the pool lives on the inventory, not the item. The destination doesn't auto-deploy (it may be a chest). Host only - who may move items between which inventories is game policy, so games route their own requests here. Returns whether the item moved.