Resource (26)
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.
OnCoalingTowerGather ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches CoalingTower.EmptyTenPercent of Assembly-CSharp.dll.
OnCoalingTowerStart ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches CoalingTower.RPC_Unload of Assembly-CSharp.dll.
OnCollectiblePickedup ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches CollectibleEntity.DoPickup of Assembly-CSharp.dll.
This hook requires OnCollectiblePickup, which loads alongside OnCollectiblePickedup.
OnCollectiblePickup ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when the player collects an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CollectibleEntity.DoPickup of Assembly-CSharp.dll.
OnDispenserBonus ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called before the player is given a bonus item for gathering.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResourceDispenser.AssignFinishBonus of Assembly-CSharp.dll.
OnDispenserBonusReceived ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches ResourceDispenser.AssignFinishBonus of Assembly-CSharp.dll.
This hook requires OnDispenserBonus, which loads alongside OnDispenserBonusReceived.
OnDispenserGather ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called before the player is given items from a resource.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResourceDispenser.GiveResourceFromItem of Assembly-CSharp.dll.
OnDispenserGathered ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches ResourceDispenser.GiveResourceFromItem of Assembly-CSharp.dll.
This hook requires OnDispenserGather, which loads alongside OnDispenserGathered.
OnExcavatorGather ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called right before moving gathered resource to container.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ExcavatorArm.ProduceResources of Assembly-CSharp.dll.
OnExcavatorMiningToggled (ExcavatorArm) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when excavator mining arm is toggled.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ExcavatorArm.BeginMining of Assembly-CSharp.dll.
OnExcavatorMiningToggled (ExcavatorArm) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when excavator mining arm is toggled.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ExcavatorArm.StopMining of Assembly-CSharp.dll.
OnExcavatorResourceSet ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when a player is trying to set a new resource target.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ExcavatorArm.RPC_SetResourceTarget of Assembly-CSharp.dll.
OnGrowableGather ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when the player gathers a growable entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GrowableEntity.PickFruit of Assembly-CSharp.dll.
OnGrowableGathered ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called before the player receives an item from gathering a growable entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GrowableEntity.GiveFruit of Assembly-CSharp.dll.
OnGrowableStateChange ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GrowableEntity.ChangeState of Assembly-CSharp.dll.
OnLootSpawn ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when loot spawns in a container.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootContainer.SpawnLoot of Assembly-CSharp.dll.
OnQuarryConsumeFuel ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches MiningQuarry.FuelCheck of Assembly-CSharp.dll.
OnQuarryGather ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called before items are gathered from a quarry.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches MiningQuarry.ProcessResources of Assembly-CSharp.dll.
OnQuarryToggle (EngineSwitch) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches EngineSwitch.StartEngine of Assembly-CSharp.dll.
OnQuarryToggle (EngineSwitch) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches EngineSwitch.StopEngine of Assembly-CSharp.dll.
OnQuarryToggled (EngineSwitch) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when a quarry has just been toggled.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches EngineSwitch.StopEngine of Assembly-CSharp.dll.
This hook requires OnQuarryToggle [off], which loads alongside OnQuarryToggled.
OnQuarryToggled (EngineSwitch) ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when a quarry has just been toggled.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches EngineSwitch.StartEngine of Assembly-CSharp.dll.
This hook requires OnQuarryToggle [on], which loads alongside OnQuarryToggled.
OnRandomItemAward ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches RandomItemDispenser.TryAward of Assembly-CSharp.dll.
OnRemoveDying ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when a player is trying to harvest a dying growable entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GrowableEntity.RemoveDying of Assembly-CSharp.dll.
OnResourceDepositCreated ![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2Fg69IVSg.png&width=300&dpr=4&quality=100&sign=81691c7&sv=1)
![](https://docs.carbonmod.gg/~gitbook/image?url=https%3A%2F%2Fi.imgur.com%2FdHr8c07.png&width=300&dpr=4&quality=100&sign=a5725a26&sv=1)
Called when a resource deposit has been created.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResourceDepositManager.CreateFromPosition of Assembly-CSharp.dll.
Called before items are gathered from a survey charge.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches SurveyCharge.Explode of Assembly-CSharp.dll.
Last updated