Item (73)
All currently available hooks that are found in Carbon. Most hooks would be ones compatible with Oxide, although there are Carbon-only ones as well.
CanAcceptItem
Called when attempting to put an item in a container.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemContainer.CanAcceptItem of Assembly-CSharp.dll.
CanCombineDroppedItem
Called when an item is dropped on another item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches DroppedItem.OnDroppedOn of Assembly-CSharp.dll.
CanDeployItem
Useful for denying items' deployment.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Deployer.DoDeploy of Assembly-CSharp.dll.
CanEquipItem
Called when the player attempts to equip an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.CanEquipItem of Assembly-CSharp.dll.
CanFastTrackCraftTask
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemCrafter.FastTrackTask of Assembly-CSharp.dll.
CanLockerAcceptItem
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches Locker.ItemFilter of Assembly-CSharp.dll.
CanMoveItem
Called when moving an item from one inventory slot to another.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.MoveItem of Assembly-CSharp.dll.
CanStackItem
Called when moving an item onto another item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.CanStack of Assembly-CSharp.dll.
CanWearItem
Called when the player attempts to equip an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.CanWearItem of Assembly-CSharp.dll.
OnBackpackDrop
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches PlayerInventory.TryDropBackpack of Assembly-CSharp.dll.
OnBonusItemDrop
Called when a loot container is about to drop bonus scrap for a player who has a corresponding tea buff.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
OnBonusItemDropped
Called after a loot container has dropped bonus scrap for a player who has a corresponding tea buff.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
This hook requires OnBonusItemDrop, which loads alongside OnBonusItemDropped.
OnBonusItemDropped [patch 1]
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
Hook flags:
This hook requires OnBonusItemDropped, which loads alongside OnBonusItemDropped [patch 1].
OnBonusItemDropped [patch 2]
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
Hook flags:
This hook requires OnBonusItemDropped [patch 1], which loads alongside OnBonusItemDropped [patch 2].
OnBonusItemDropped [patch 3]
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
Hook flags:
This hook requires OnBonusItemDropped [patch 2], which loads alongside OnBonusItemDropped [patch 3].
OnBonusItemDropped [patch 4]
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
Hook flags:
This hook requires OnBonusItemDropped [patch 3], which loads alongside OnBonusItemDropped [patch 4].
OnBonusItemDropped [patch 5]
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.DropBonusItems of Assembly-CSharp.dll.
Hook flags:
This hook requires OnBonusItemDropped [patch 4], which loads alongside OnBonusItemDropped [patch 5].
OnDroppedItemCombined
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches DroppedItem.OnDroppedOn of Assembly-CSharp.dll.
OnFindBurnable
Called when looking for fuel for the oven.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseOven.FindBurnable of Assembly-CSharp.dll.
OnHealingItemUse
Called when a player attempts to use a medical tool.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches MedicalTool.GiveEffectsTo of Assembly-CSharp.dll.
OnInventoryAmmoFind
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.FindAmmo of Assembly-CSharp.dll.
OnInventoryAmmoItemFind (Chainsaw)
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Chainsaw.GetAmmo of Assembly-CSharp.dll.
OnInventoryAmmoItemFind (FlameThrower)
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches FlameThrower.GetAmmo of Assembly-CSharp.dll.
OnInventoryItemsCount
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.GetAmount of Assembly-CSharp.dll.
OnInventoryItemsFind
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.FindItemsByItemID of Assembly-CSharp.dll.
OnInventoryItemsTake
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.Take of Assembly-CSharp.dll.
OnItemAction
Called when a button is clicked on an item in the inventory (drop, unwrap, ...).
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.ItemCmd of Assembly-CSharp.dll.
OnItemAddedToContainer
Called right after an item was added to a container.
An entire stack has to be created, not just adding more wood to a wood stack for example.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemContainer.Insert of Assembly-CSharp.dll.
OnItemCraft
Called right after an item is added to the crafting queue.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemCrafter.CraftItem of Assembly-CSharp.dll.
OnItemCraftCancelled
Called before an item has been crafted.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemCrafter.CancelTask of Assembly-CSharp.dll.
OnItemCraftFinished
Called right after an item has been crafted.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemCrafter.FinishCrafting of Assembly-CSharp.dll.
OnItemDeployed (Deployer)
Called right after an item has been deployed.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Deployer.DoDeploy_Regular of Assembly-CSharp.dll.
OnItemDeployed (Deployer)
Called right after an item has been deployed.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Deployer.DoDeploy_Slot of Assembly-CSharp.dll.
OnItemDespawn
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches DroppedItem.IdleDestroy of Assembly-CSharp.dll.
OnItemDropped
Called right after an item has been dropped.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.Drop of Assembly-CSharp.dll.
OnItemFilter
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches StorageContainer.ItemFilter of Assembly-CSharp.dll.
OnItemLock
Called right before an item is locked, such as in a modular car inventory.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.LockUnlock of Assembly-CSharp.dll.
OnItemPainted
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PaintedItemStorageEntity.Server_UpdateImage of Assembly-CSharp.dll.
OnItemPickup
Called right after an item has been picked up.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WorldItem.Pickup of Assembly-CSharp.dll.
OnItemRecycle (Recycler)
Called when an item is recycled in a recycler.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Recycler.RecycleThink of Assembly-CSharp.dll.
OnItemRecycle (Recycler)
Called when an item is recycled in a recycler.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Recycler.RecycleThink of Assembly-CSharp.dll.
This hook requires OnItemRecycle, which loads alongside OnItemRecycle.
OnItemRecycleAmount
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Recycler.RecycleThink of Assembly-CSharp.dll.
This hook requires OnItemRecycle [2], which loads alongside OnItemRecycleAmount.
OnItemRefill
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemModRepair.ServerCommand of Assembly-CSharp.dll.
OnItemRemove
Called before an item is destroyed.
Return a non-null value stop item from being destroyed.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.Remove of Assembly-CSharp.dll.
OnItemRemovedFromContainer
Called right after an item was removed from a container.
The entire stack has to be removed for this to be called, not just a little bit.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemContainer.Remove of Assembly-CSharp.dll.
OnItemRepair
Called right before an item is repaired.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches RepairBench.RepairAnItem of Assembly-CSharp.dll.
OnItemResearch
Called right before a player begins to research an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResearchTable.DoResearch of Assembly-CSharp.dll.
This hook requires CanResearchItem, which loads alongside OnItemResearch.
OnItemResearched
Called right before a player finishes researching an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResearchTable.ResearchAttemptFinished of Assembly-CSharp.dll.
OnItemSkinChange
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches RepairBench.ChangeSkin of Assembly-CSharp.dll.
OnItemSplit
Called right before an item is split into multiple stacks.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.SplitItem of Assembly-CSharp.dll.
OnItemStacked (Item)
Called after an item has been stacked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.MoveToContainer of Assembly-CSharp.dll.
OnItemStacked (Item)
Called after an item has been stacked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.MoveToContainer of Assembly-CSharp.dll.
This hook requires OnItemStacked [1], which loads alongside OnItemStacked.
OnItemSubmit
Called when a player submits an item into a mailbox or dropbox.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Mailbox.SubmitInputItems of Assembly-CSharp.dll.
OnItemUnlock
Called right before an item is unlocked, such as in a modular car inventory.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.LockUnlock of Assembly-CSharp.dll.
This hook requires OnItemLock, which loads alongside OnItemUnlock.
OnItemUnwrap
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemModUnwrap.ServerCommand of Assembly-CSharp.dll.
OnItemUpgrade
Called right before an item is upgraded.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemModUpgrade.ServerCommand of Assembly-CSharp.dll.
OnItemUse
Called when an item is used.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.UseItem of Assembly-CSharp.dll.
OnLoseCondition
Called right before the condition of the item is modified.
Called right before the condition of the item is modified.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CorePlugin.IOnLoseCondition.
OnMapImageUpdated
Called when player updates map item's image.
Useful for executing any action when map image is updated.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches MapEntity.ImageUpdate of Assembly-CSharp.dll.
OnMaxStackable
Called when an items max stackable is calculated.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Item.MaxStackable of Assembly-CSharp.dll.
OnRackedWeaponLoad
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.LoadWeaponAmmo of Assembly-CSharp.dll.
OnRackedWeaponLoaded
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.LoadWeaponAmmo of Assembly-CSharp.dll.
This hook requires OnRackedWeaponLoad, which loads alongside OnRackedWeaponLoaded.
OnRackedWeaponMount
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.MountWeapon of Assembly-CSharp.dll.
OnRackedWeaponMounted
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.MountWeapon of Assembly-CSharp.dll.
This hook requires OnRackedWeaponMount, which loads alongside OnRackedWeaponMounted.
OnRackedWeaponSwap
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.SwapPlayerWeapon of Assembly-CSharp.dll.
OnRackedWeaponSwapped
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.SwapPlayerWeapon of Assembly-CSharp.dll.
This hook requires OnRackedWeaponSwap, which loads alongside OnRackedWeaponSwapped.
OnRackedWeaponTake
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.GivePlayerWeapon of Assembly-CSharp.dll.
OnRackedWeaponTaken
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.GivePlayerWeapon of Assembly-CSharp.dll.
This hook requires OnRackedWeaponTake, which loads alongside OnRackedWeaponTaken.
OnRackedWeaponUnload
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.UnloadWeapon of Assembly-CSharp.dll.
OnRackedWeaponUnloaded
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WeaponRack.UnloadWeapon of Assembly-CSharp.dll.
This hook requires OnRackedWeaponUnload, which loads alongside OnRackedWeaponUnloaded.
OnResearchCostDetermine (ResearchTable)
Called when an item is being scrapped at a research table or when a blueprint is being unlocked in a tech tree.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResearchTable.ScrapForResearch of Assembly-CSharp.dll.
OnResearchCostDetermine (ResearchTable)
Called when an item is being scrapped at a research table or when a blueprint is being unlocked in a tech tree.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResearchTable.ScrapForResearch of Assembly-CSharp.dll.
Last updated