s&box

BaseInventoryItem

build Constructors 1

BaseInventoryItem ()

data_object Properties 9

Icon shown in inventory UI.

Display name shown in inventory UI.

InventoryComponent

The inventory this item currently belongs to, or null if it isn't in one. Derived from the hierarchy so it's correct on every peer. The nearest ancestor, never this item's own GameObject - an item that is itself an inventory (a backpack) belongs to its holder.

True when this is the active (deployed) item in its inventory.

The slot this item wants when added without an explicit one (GMod's SWEP.Slot). In a hotbar inventory it falls back to the first empty slot when taken, with -1 for no preference; in a buckets inventory the preference always wins.

True when the inventory should avoid auto-switching to this item - e.g. a gun with nothing to fire. Sandbox.InventoryComponent.GetBestItem falls back to avoided items only when there's nothing better.

The slot this item occupies, or -1 if unassigned. Set by the inventory.

Fixed sort position among items sharing a slot, lowest first (GMod's SWEP.SlotPos). Only matters in a buckets inventory - hotbar slots hold one item.

Relative worth of this item. Used as the priority when the inventory has to pick a "best" item to fall back to (e.g. after the active item is removed). Higher wins.

functions Methods 12

CanPickup (inventory)

True when the given inventory is allowed to pick this item up (see Sandbox.BaseInventoryItem.OnCanPickup(Sandbox.InventoryComponent)). Queryable by UI - a pure check, nothing happens.

True when the inventory is allowed to make this the active item (see Sandbox.BaseInventoryItem.OnCanSwitchTo). Queryable by UI - a pure check, nothing happens.

OnAdded (inventory)

Called on the host when added to an inventory. Base does nothing.

OnAdding (inventory)

About to be added to . Return false to refuse - optionally consuming this item instead (a duplicate weapon donates its ammo, a stackable merges into its stack). Runs on the host for every add - pickups, loadouts, code. Base allows it.

OnCanPickup (inventory)

Can the given inventory pick this item up out of the world? Both the Use prompt and Touch pickup consult it, so a refused item shows no prompt - role-locked weapons, class restrictions, quest gates. Base allows it.

OnCanSwitchTo ()

Return false to stop the inventory making this item active.

Called each frame on the owning client while this is the active item - read input and drive the item's behaviour here (firing, reloading, aiming, etc). Pumped by the inventory; see Sandbox.InventoryComponent.Pump and Sandbox.InventoryComponent.ManualPumping. Base does nothing.

Places this item in the world after being dropped. The default unparents it (keeping its world position), enables it, drops network ownership, and gives it a small toss if it has a Sandbox.Rigidbody. Return false to refuse the drop (e.g. bound items). Override to customise placement or behaviour.

Called on every peer when this becomes the active item. Base does nothing.

Called on every peer when this stops being the active item. Base does nothing.

OnHolstering (next)

The inventory is about to switch away from this (the active) item - to , or to nothing when it's null. Return false to refuse and stay deployed (stash to finish a put-down and re-issue the switch), or handle it here - e.g. cancel an in-progress reload - and return true to allow the switch. Not called on forced holsters (death, removal, dropping). Base allows it.

OnRemoved (inventory)

Called on the host when removed from an inventory. Base does nothing.

Inheritance

BaseInventoryItem

people

Log in to reply

You can't reply if you're not logged in. That would be crazy.