Carbon Documentation
Get CarbonPluginsDiscord
Get CarbonPluginsDiscord
  • Carbon for Rust
  • ⚙️Installing Carbon
  • ⚙️Configuring Carbon
  • Release Notes
  • Development
    • 🖥️Local Server Hosting
    • 📦Creating your Project
    • 🐒Creating your First Plugin
    • 🎯Debugging Plugins
      • 🔧JetBrains Rider Setup
      • 🔧Visual Studio Setup
    • 🧱Features
      • 🔧Conditionals
      • 🔧Async Shutdown
      • 🔧ZIP Scripts & Packages
      • 🔧Profiler (Mono)
    • 🛠️Builds & Branches
    • 🥳Oxide Porting
  • Core
    • 🕹️Commands
    • 🪝Hooks
      • Animal (14)
      • Bookmark (9)
      • Clan (1)
      • Crafting (8)
      • CUI (2)
      • Electronic (20)
      • Elevator (6)
      • Engine (4)
      • Entity (120)
      • Firework (6)
      • Fishing (6)
      • Fixes (10)
      • Fuel (7)
      • Fun (3)
      • Industrial (2)
      • Item (75)
      • Mission (6)
      • Network (7)
      • NPC (23)
      • Permissions (12)
      • Pet (2)
      • Phone (10)
      • Player (177)
      • Plugin (6)
      • Primitive (7)
      • Queue (4)
      • Radio (20)
      • Resource (26)
      • Resources (1)
      • Seasonal (9)
      • Server (24)
      • Shop (3)
      • Static (9)
      • Structure (40)
      • Team (12)
      • TechTree (4)
      • Traps (7)
      • Turret (16)
      • Vehicle (54)
      • Vending (25)
      • Weapon (30)
      • World (3)
    • 🍥CUI
      • Create Elements
        • Container
        • Panel
        • Text
        • Button
        • ProtectedButton
        • InputField
        • ProtectedInputField
        • Sprite
        • Image
        • ItemImage
        • ClientImage
        • QR Code Image
        • Countdown
      • Update Elements
    • 📑Modals
    • 🧲Extensions
    • 🎳Modules
      • Admin Module
        • Codefling Auth
        • Permissions
      • AutoWipe Module
      • Image Database Module
    • ⚠️Warnings
  • Collaborate
    • ⚓Adding Hooks
      • 🌟Community Hooks
      • ⭐Plugin Patches / Hooks
  • Rust
    • Items
    • Entities
      • Singulars (271)
      • ANDSwitch (2)
      • Barricade (21)
      • BaseArcadeMachine (2)
      • BaseChair (14)
      • BaseCombatEntity (13)
      • BaseCorpse (10)
      • BaseEntity (48)
      • BaseFirework (3)
      • BaseFuelLightSource (2)
      • BaseGameMode (7)
      • BaseLauncher (3)
      • BaseLiquidVessel (4)
      • BaseMelee (39)
      • BaseOven (18)
      • BasePlayer (2)
      • BasePortal (3)
      • BaseProjectile (28)
      • BaseSubmarine (2)
      • BaseVehicle (4)
      • BaseVehicleModule (2)
      • BaseVehicleSeat (24)
      • Bear (2)
      • Bike (5)
      • BikeDriverSeat (2)
      • BikeSeat (2)
      • BlackjackMachine (2)
      • BowWeapon (2)
      • BoxStorage (7)
      • BuildingBlock (20)
      • BuildingPrivlidge (2)
      • BushEntity (44)
      • Candle (2)
      • CardGamePlayerStorage (2)
      • CardTable (9)
      • Cassette (3)
      • CCTV_RC (4)
      • Chicken (2)
      • ChineseLantern (2)
      • CinematicEntity (29)
      • ClanTable (3)
      • CollectableEasterEgg (2)
      • CollectibleEntity (22)
      • ComputerStation (4)
      • ConnectedSpeaker (2)
      • DebrisEntity (3)
      • DecorDeployable (11)
      • DeployableBoomBox (2)
      • DeployedFigurine (2)
      • DiscoFloor (2)
      • DiveSite (6)
      • DiveSiteBuoy (2)
      • Door (55)
      • DoorKnocker (3)
      • DoorManipulator (2)
      • DropBox (2)
      • DroppedItemContainer (3)
      • DudTimedExplosive (2)
      • DummySwitch (2)
      • DynamicDungeon (2)
      • EasterBasket (2)
      • ElectricalCombiner (3)
      • ElectricBattery (3)
      • ElectricGenerator (4)
      • ElectricSwitch (4)
      • ElevatorLiftStatic (2)
      • ElevatorStatic (3)
      • EngineSwitch (2)
      • FireBall (10)
      • FlameExplosive (3)
      • FlameThrower (2)
      • FreeableLootContainer (2)
      • GingerbreadNPC (2)
      • GrenadeWeapon (7)
      • GrowableEntity (10)
      • HackableLockedCrate (3)
      • HarborProximityEntity (2)
      • HelicopterDebris (4)
      • HuntingTrophy (2)
      • IceFence (2)
      • IndustrialStorageAdaptor (2)
      • InstrumentTool (5)
      • InstrumentToolGuitar (3)
      • InvisibleVendingMachine (2)
      • IOEntity (5)
      • ItemPickup (3)
      • JunkPile (10)
      • JunkPileWater (3)
      • Lift (3)
      • LightListener (3)
      • LiquidContainer (4)
      • LiquidWeapon (2)
      • LockedByEntCrate (2)
      • Locker (2)
      • LootContainer (72)
      • MapMarker (4)
      • MapMarkerCH47 (4)
      • MedicalTool (2)
      • MicrophoneStand (2)
      • MicrophoneStandIOEntity (2)
      • MiningQuarry (4)
      • ModularCar (38)
      • ModularCarGarage (2)
      • ModularCarSeat (6)
      • MortarFirework (6)
      • NeonSign (5)
      • NPCAutoTurret (6)
      • NPCDwelling (95)
      • NPCMissionProvider (9)
      • NPCPlayerCorpse (5)
      • NPCShopKeeper (2)
      • NPCVendingMachine (20)
      • OreHotSpot (2)
      • OreResourceEntity (13)
      • ORSwitch (2)
      • PaddlingPool (2)
      • PFXRepeatingFirework (4)
      • PhotoFrame (19)
      • PlanterBox (5)
      • PlatformEntity (3)
      • PlayerCorpse (2)
      • PressButton (3)
      • PressButton_TrainTunnel (4)
      • ProceduralDynamicDungeon (2)
      • ProceduralLift (7)
      • ProjectileWeaponMod (18)
      • ReflectionPlane (20)
      • RepairBench (2)
      • ResearchTable (2)
      • ResourceEntity (24)
      • ResourceExtractorFuelStorage (4)
      • RFBroadcaster (2)
      • RockingChair (3)
      • Rust.Modular.EngineStorage (2)
      • RustigeEgg (6)
      • SamSite (2)
      • ScarecrowNPC (3)
      • ScientistNPC (22)
      • SeasonalTimedExplosive (2)
      • ShopFront (2)
      • Signage (17)
      • SimpleBuildingBlock (23)
      • SimpleLight (7)
      • SkullTrophy (4)
      • SkyLantern (5)
      • Sled (2)
      • SledSeat (4)
      • SleepingBag (3)
      • SlotMachine (3)
      • SmokeGrenade (2)
      • Snowmobile (3)
      • SphereEntity (5)
      • Splitter (4)
      • StabilityEntity (2)
      • StaticInstrument (6)
      • StaticRespawnArea (2)
      • Stocking (2)
      • StorageContainer (28)
      • SupplyDrop (2)
      • SurveyCrater (2)
      • Telephone (2)
      • ThrownWeapon (3)
      • TimedExplosive (12)
      • TorchWeapon (3)
      • TrainCar (5)
      • TrainCarUnloadable (2)
      • TrainEngine (5)
      • TrainSignal (2)
      • TreeEntity (136)
      • TreeMarker (2)
      • TunnelDweller (2)
      • TwitchTrophy (2)
      • VehicleModuleEngine (2)
      • VehicleModuleSeating (5)
      • VehicleModuleStorage (2)
      • VehicleSpawner (2)
      • VehicleVendor (3)
      • WantedPoster (4)
      • WaterCatcher (3)
      • WaterInflatable (4)
      • WeaponRack (7)
      • WheelSwitch (2)
      • WhitelistLootContainer (4)
      • WireTool (3)
      • Workbench (5)
      • XORSwitch (3)
    • Blueprints
    • Loot Tables
  • Libraries
    • Commands
    • Permissions
    • Timers
  • Server Hosting
    • 🐧LinuxGSM
  • Optional Modules
    • Gather Manager Module
    • Stack Manager Module
    • Vanish Module
    • Whitelist Module
    • Optimisations Module
    • Moderation Tools Module
Powered by GitBook
On this page
  • CanBeAwardedAdventGift
  • OnAdventGiftAward
  • OnAdventGiftAwarded
  • OnEventCollectablePickup
  • OnHuntEventEnd
  • OnHuntEventStart
  • OnXmasGiftsDistribute
  • OnXmasLootDistribute
  • OnXmasStockingFill
  1. Core
  2. Hooks

Seasonal (9)

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.

PreviousResources (1)NextServer (24)

Last updated 1 month ago

CanBeAwardedAdventGift

  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches AdventCalendar.WasAwardedTodaysGift of Assembly-CSharp.dll.

Example
object CanBeAwardedAdventGift()
{
    Puts("CanBeAwardedAdventGift was called!");
    return (object) null;
}

OnAdventGiftAward

  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches AdventCalendar.AwardGift of Assembly-CSharp.dll.

Example
object OnAdventGiftAward(AdventCalendar self)
{
    Puts("OnAdventGiftAward was called!");
    return (object) null;
}
  • No return behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches AdventCalendar.AwardGift of Assembly-CSharp.dll.

Example
void OnAdventGiftAwarded(AdventCalendar self)
{
    Puts("OnAdventGiftAwarded was called!");
}

This hook requires OnAdventGiftAward, which loads alongside OnAdventGiftAwarded.

  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches CollectableEasterEgg.RPC_PickUp of Assembly-CSharp.dll.

Example
object OnEventCollectablePickup(BasePlayer player, CollectableEasterEgg self)
{
    Puts("OnEventCollectablePickup was called!");
    return (object) null;
}
  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches EggHuntEvent.Update of Assembly-CSharp.dll.

Example
object OnHuntEventEnd(EggHuntEvent self)
{
    Puts("OnHuntEventEnd was called!");
    return (object) null;
}
  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches EggHuntEvent.StartEvent of Assembly-CSharp.dll.

Example
object OnHuntEventStart(EggHuntEvent self)
{
    Puts("OnHuntEventStart was called!");
    return (object) null;
}
  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches XMasRefill.DistributeGiftsForPlayer of Assembly-CSharp.dll.

Example
object OnXmasGiftsDistribute()
{
    Puts("OnXmasGiftsDistribute was called!");
    return (object) null;
}
  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches XMasRefill.ServerInit of Assembly-CSharp.dll.

Example
object OnXmasLootDistribute(XMasRefill self)
{
    Puts("OnXmasLootDistribute was called!");
    return (object) null;
}
  • Returning a non-null value cancels default behavior.

  • This hook is compatible within Carbon and Oxide.

  • Patches Stocking.SpawnLoot of Assembly-CSharp.dll.

Example
object OnXmasStockingFill(Stocking self)
{
    Puts("OnXmasStockingFill was called!");
    return (object) null;
}

OnAdventGiftAwarded

OnEventCollectablePickup

OnHuntEventEnd

OnHuntEventStart

OnXmasGiftsDistribute

OnXmasLootDistribute

OnXmasStockingFill

🪝