Player (169)
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.
Called when a player attempts to assign a bed or sleeping bag to another player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches SleepingBag.AssignToFriend of Assembly-CSharp.dll.
Called when an autoturret, flame turret, shotgun trap, or helicopter turret is attempting to target the player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches AutoTurret.ObjectVisible of Assembly-CSharp.dll.
Called when an autoturret, flame turret, shotgun trap, or helicopter turret is attempting to target the player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches HelicopterTurret.InFiringArc of Assembly-CSharp.dll.
Called when an autoturret, flame turret, shotgun trap, or helicopter turret is attempting to target the player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches FlameTurret.CheckTrigger of Assembly-CSharp.dll.
Called when an autoturret, flame turret, shotgun trap, or helicopter turret is attempting to target the player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GunTrap.CheckTrigger of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches FlameTurret.CheckTrigger of Assembly-CSharp.dll.
Hook flags:
This hook requires CanBeTargeted [FlameTurret], which loads alongside CanBeTargeted [patch].
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GunTrap.CheckTrigger of Assembly-CSharp.dll.
Hook flags:
This hook requires CanBeTargeted [GunTrap], which loads alongside CanBeTargeted [patch].
Called when any damage is attempted on player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.EligibleForWounding of Assembly-CSharp.dll.
Called before the player is added to the connection queue.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ConnectionQueue.CanJumpQueue of Assembly-CSharp.dll.
Called when a player tries to change the code on a codelock.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CodeLock.RPC_ChangeCode of Assembly-CSharp.dll.
Gets called when a client should or not should join the server.
Called when the player is attempting to login.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CorePlugin.IOnUserApprove.
Called when the player attempts to dismount an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMountable.DismountPlayer of Assembly-CSharp.dll.
Called when a player attempts to drop their active item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.ShouldDropActiveItem of Assembly-CSharp.dll.
Called when a player starts hacking a locked crate.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches HackableLockedCrate.RPC_Hack of Assembly-CSharp.dll.
Called when a player tries to hide a stash.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches StashContainer.RPC_HideStash of Assembly-CSharp.dll.
Useful for canceling the lock action.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CodeLock.TryLock of Assembly-CSharp.dll.
Useful for canceling the lock action.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches KeyLock.Lock of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootableCorpse.RPC_LootCorpse of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches StorageContainer.PlayerOpenLoot of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ResourceContainer.StartLootingContainer of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches DroppedItemContainer.RPC_OpenLoot of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseRidableAnimal.RPC_OpenLoot of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ContainerIOEntity.PlayerOpenLoot of Assembly-CSharp.dll.
Called when the player starts looting a DroppedItemContainer, LootableCorpse, ResourceContainer, BaseRidableAnimal, or StorageContainer entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches IndustrialCrafter.PlayerOpenLoot of Assembly-CSharp.dll.
Called when the player attempts to loot another player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.CanBeLooted of Assembly-CSharp.dll.
Called when the player attempts to mount an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMountable.MountPlayer of Assembly-CSharp.dll.
Called when an entity attempts to network with a player.
For better performance, avoid using heavy calculations in this hook.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.ShouldNetworkTo of Assembly-CSharp.dll.
Called when a player attempts to pickup a deployed entity (AutoTurret, BaseMountable, BearTrap, DecorDeployable, Door, DoorCloser, ReactiveTarget, SamSite, SleepingBag, SpinnerWheel, StorageContainer, etc.).
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseCombatEntity.CanPickup of Assembly-CSharp.dll.
Called when a player attempts to pickup a lock.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseLock.RPC_TakeLock of Assembly-CSharp.dll.
Overrides the IsSpectating check, overriding the result.
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches BasePlayer.ShouldInheritNetworkGroup.
Called when the player attempts to rename a bed or sleeping bag.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches SleepingBag.Rename of Assembly-CSharp.dll.
Called when the player attempts 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.
Called when a player tries to set a bed public.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches SleepingBag.RPC_MakePublic of Assembly-CSharp.dll.
Called when a player's relationship with another is about to be updated.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches RelationshipManager.SetRelationship of Assembly-CSharp.dll.
Called when spectate target is attempting to update.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.UpdateSpectateTarget of Assembly-CSharp.dll.
Called when a player tries to switch seats, to determine whether each seat is eligible to be swapped to.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMountable.CanSwapToThis of Assembly-CSharp.dll.
Called when a player tries to switch seats, to determine whether each seat is eligible to be swapped to.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ModularCarSeat.CanSwapToThis of Assembly-CSharp.dll.
Called when a player is trying to take a cutting (clone) of a GrowableEntity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GrowableEntity.TakeClones of Assembly-CSharp.dll.
Called when the player tries to unlock a keylock or codelock.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CodeLock.TryUnlock of Assembly-CSharp.dll.
Called when the player tries to unlock a keylock or codelock.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches KeyLock.RPC_Unlock of Assembly-CSharp.dll.
Called when the player tries to unlock a keylock or codelock.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ModularCarCodeLock.TryOpenWithCode of Assembly-CSharp.dll.
Called when the player attempts to change the text on a sign or lock it, or update a photo frame.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Signage.CanUpdateSign of Assembly-CSharp.dll.
Called when the player attempts to change the text on a sign or lock it, or update a photo frame.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PhotoFrame.CanUpdateSign of Assembly-CSharp.dll.
Called when the player attempts to change the text on a sign or lock it, or update a photo frame.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CarvablePumpkin.CanUpdateSign of Assembly-CSharp.dll.
Called when a player attempts to use a gesture.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches GestureConfig.IsOwnedBy of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches HBHFSensor.CanUse of Assembly-CSharp.dll.
Called when the player tries to use an entity that is locked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CodeLock.OnTryToOpen of Assembly-CSharp.dll.
Called when the player tries to use an entity that is locked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CodeLock.OnTryToClose of Assembly-CSharp.dll.
Called when the player tries to use an entity that is locked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches KeyLock.OnTryToClose of Assembly-CSharp.dll.
Called when the player tries to use an entity that is locked.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches KeyLock.OnTryToOpen of Assembly-CSharp.dll.
Called when the player tries to use a mailbox.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Mailbox.PlayerIsOwner of Assembly-CSharp.dll.
Gets called when a client should or not should join the server.
Called when a player is attempting to connect to the server.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CorePlugin.IOnUserApprove.
Useful for allowing or preventing a player from using wires.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches WireTool.CanPlayerUseWires of Assembly-CSharp.dll.
Called when active item is attempting to update.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.UpdateActiveItem of Assembly-CSharp.dll.
Called when active item was changed.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.UpdateActiveItem of Assembly-CSharp.dll.
This hook requires OnActiveItemChange, which loads alongside OnActiveItemChanged.
Called when the player is giving server connection authorization information.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ServerMgr.OnGiveUserInformation of Assembly-CSharp.dll.
Useful for intercepting players' commands before their handling.
Called before OnPlayerCommand and OnUserCommand.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ConsoleNetwork.OnClientCommand of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ServerMgr.ReadDisconnectReason of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Server.OnDisconnected of Facepunch.Network.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseProjectile.CreateProjectileEffectClientside of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.OnClothingChanged of Assembly-CSharp.dll.
Called when a player is about to receive default items.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.GiveDefaultItems of Assembly-CSharp.dll.
Called after a player has received default items.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.GiveDefaultItems of Assembly-CSharp.dll.
This hook requires OnDefaultItemsReceive, which loads alongside OnDefaultItemsReceived.
Called right before a demo of a player starts recording.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.StartDemoRecording of Assembly-CSharp.dll.
Called after a demo of a player has started recording.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.StartDemoRecording of Assembly-CSharp.dll.
This hook requires OnDemoRecordingStart, which loads alongside OnDemoRecordingStarted.
Called right before a demo of a player stops recording.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.StopDemoRecording of Assembly-CSharp.dll.
Called after a demo of a player has stopped recording.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.StopDemoRecording of Assembly-CSharp.dll.
This hook requires OnDemoRecordingStop, which loads alongside OnDemoRecordingStopped.
Called when an entity is mounted by a player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMountable.MountPlayer of Assembly-CSharp.dll.
This hook requires CanMountEntity, which loads alongside OnEntityMounted.
Called when an experiment is about to end.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Workbench.ExperimentComplete of Assembly-CSharp.dll.
Called after the experiment has finished.
No return behaviour.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Workbench.ExperimentComplete of Assembly-CSharp.dll.
This hook requires OnExperimentEnd, which loads alongside OnExperimentEnded.
Called when the player attempts to experiment with at a workbench.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Workbench.RPC_BeginExperiment of Assembly-CSharp.dll.
Called after the experimentation has started.
No return behaviour.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Workbench.RPC_BeginExperiment of Assembly-CSharp.dll.
This hook requires OnExperimentStart, which loads alongside OnExperimentStarted.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches AttackEntity.ValidateEyePos of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.OnFeedbackReport of Assembly-CSharp.dll.
Useful for controlling player spawnpoints (like making all spawns occur in a set area).
Return a BasePlayer.SpawnPoint object to use that spawnpoint.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ServerMgr.FindSpawnPoint of Assembly-CSharp.dll.
Called after a player's inventory contents have changed, before it is sent over the network to one or more clients.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerInventory.SendUpdatedInventoryInternal of Assembly-CSharp.dll.
Called when the player starts looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerLoot.StartLootingEntity of Assembly-CSharp.dll.
Called when the player stops looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches LootableCorpse.PlayerStoppedLooting of Assembly-CSharp.dll.
Called when the player stops looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches StorageContainer.PlayerStoppedLooting of Assembly-CSharp.dll.
Called when the player stops looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches DroppedItemContainer.PlayerStoppedLooting of Assembly-CSharp.dll.
Called when the player stops looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ContainerIOEntity.PlayerStoppedLooting of Assembly-CSharp.dll.
Called when the player stops looting an entity.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemBasedFlowRestrictor.PlayerStoppedLooting of Assembly-CSharp.dll.
Called when the player starts looting an item.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerLoot.StartLootingItem of Assembly-CSharp.dll.
Called when a player is trying to loot a container or a container they are looting has changed its contents.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches PlayerLoot.SendUpdate of Assembly-CSharp.dll.
Called when the player starts looting another player.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.RPC_LootPlayer of Assembly-CSharp.dll.
Called when trying to add a marker.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.Server_AddMarker of Assembly-CSharp.dll.
Called after a marker was added.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.Server_AddMarker of Assembly-CSharp.dll.
This hook requires OnMapMarkerAdd, which loads alongside OnMapMarkerAdded.
Called when trying to remove a marker.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.Server_RemovePointOfInterest of Assembly-CSharp.dll.
Called when trying to clear map markers.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.Server_ClearMapMarkers of Assembly-CSharp.dll.
Called after markers were cleared.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.Server_ClearMapMarkers of Assembly-CSharp.dll.
This hook requires OnMapMarkersClear, which loads alongside OnMapMarkersCleared.
Useful for canceling melee attacks.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMelee.PlayerAttack of Assembly-CSharp.dll.
Returning a non-null value cancels default behavior.
This hook is Carbon-only compatible.
Patches BaseMetalDetector.RPC_RequestFlag of Assembly-CSharp.dll.
Called when a player is paying for placement. Useful for preventing paying for placing deployables, building blocks and etc.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches Planner.PayForPlacement of Assembly-CSharp.dll.
Called when player is paying for an upgrade. Useful for preventing paying for block upgrade.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BuildingBlock.PayForUpgrade of Assembly-CSharp.dll.
Called after a player consumes an item such as tea that is about to apply modifiers.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches ItemModConsume.DoAction of Assembly-CSharp.dll.
Called when a player tries to assist target player (when target is wounded).
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.RPC_Assist of Assembly-CSharp.dll.
Useful for modifying an attack before it goes out.
hitInfo.HitEntity should be the entity that this attack would hit.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BaseMelee.DoAttackShared of Assembly-CSharp.dll.
Useful for modifying an attack before it goes out.
hitInfo.HitEntity should be the entity that this attack would hit.
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches BasePlayer.OnProjectileAttack of Assembly-CSharp.dll.
Called when the player is banned (Facepunch, EAC, server ban, etc.).
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches EACServer.OnClientActionRequired of Assembly-CSharp.dll.
Gets called when a connection gets banned.
Called when the player is banned (Facepunch, EAC, server ban, etc.).
Returning a non-null value cancels default behavior.
This hook is compatible within Carbon and Oxide.
Patches CorePlugin.IOnPlayerBanned.