Player (171)

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.

CanAssignBed

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches SleepingBag.AssignToFriend of Assembly-CSharp.dll.

Example

object CanAssignBed(BasePlayer BasePlayer , SleepingBag SleepingBag , ulong UInt64 )
{
    Puts("CanAssignBed was called!");
    return (object) null;
}

CanBeTargeted (AutoTurret)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches AutoTurret.ObjectVisible of Assembly-CSharp.dll.

Example

object CanBeTargeted(BaseCombatEntity BaseCombatEntity , AutoTurret AutoTurret )
{
    Puts("CanBeTargeted was called!");
    return (bool) null;
}

CanBeTargeted (HelicopterTurret)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches HelicopterTurret.InFiringArc of Assembly-CSharp.dll.

Example

object CanBeTargeted(BaseCombatEntity BaseCombatEntity , HelicopterTurret HelicopterTurret )
{
    Puts("CanBeTargeted was called!");
    return (bool) null;
}

CanBeTargeted (FlameTurret)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches FlameTurret.CheckTrigger of Assembly-CSharp.dll.

Example

object CanBeTargeted(BasePlayer BasePlayer , FlameTurret FlameTurret )
{
    Puts("CanBeTargeted was called!");
    return (bool) null;
}

CanBeTargeted (GunTrap)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches GunTrap.CheckTrigger of Assembly-CSharp.dll.

Example

object CanBeTargeted(BasePlayer BasePlayer , GunTrap GunTrap )
{
    Puts("CanBeTargeted was called!");
    return (bool) null;
}

CanBeTargeted [patch] (FlameTurret)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches FlameTurret.CheckTrigger of Assembly-CSharp.dll.

• Hook flags:

Example

void CanBeTargeted()
{
    Puts("CanBeTargeted [patch] was called!");
}

This hook requires CanBeTargeted [FlameTurret], which loads alongside CanBeTargeted [patch].

CanBeTargeted [patch] (GunTrap)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches GunTrap.CheckTrigger of Assembly-CSharp.dll.

• Hook flags:

Example

void CanBeTargeted()
{
    Puts("CanBeTargeted [patch] was called!");
}

This hook requires CanBeTargeted [GunTrap], which loads alongside CanBeTargeted [patch].

CanBeWounded

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.EligibleForWounding of Assembly-CSharp.dll.

Example

object CanBeWounded(BasePlayer BasePlayer )
{
    Puts("CanBeWounded was called!");
    return (bool) null;
}

CanBypassQueue

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ConnectionQueue.CanJumpQueue of Assembly-CSharp.dll.

Example

object CanBypassQueue()
{
    Puts("CanBypassQueue was called!");
    return (bool) null;
}

CanChangeCode

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CodeLock.RPC_ChangeCode of Assembly-CSharp.dll.

Example

object CanChangeCode(BasePlayer BasePlayer , CodeLock CodeLock , string String , bool Boolean )
{
    Puts("CanChangeCode was called!");
    return (object) null;
}

CanClientLogin

• Gets called when a client should or not should join the server.

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnUserApprove.

Example

object CanClientLogin(Network.Connection Connection )
{
    Puts("CanClientLogin was called!");
    return (bool) null;
}

CanDismountEntity

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.DismountPlayer of Assembly-CSharp.dll.

Example

object CanDismountEntity(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("CanDismountEntity was called!");
    return (object) null;
}

CanDropActiveItem

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.ShouldDropActiveItem of Assembly-CSharp.dll.

Example

object CanDropActiveItem(BasePlayer BasePlayer )
{
    Puts("CanDropActiveItem was called!");
    return (bool) null;
}

CanHackCrate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches HackableLockedCrate.RPC_Hack of Assembly-CSharp.dll.

Example

object CanHackCrate(BasePlayer BasePlayer , HackableLockedCrate HackableLockedCrate )
{
    Puts("CanHackCrate was called!");
    return (object) null;
}

CanHideStash

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StashContainer.RPC_HideStash of Assembly-CSharp.dll.

Example

object CanHideStash(BasePlayer BasePlayer , StashContainer StashContainer )
{
    Puts("CanHideStash was called!");
    return (object) null;
}

CanLock (CodeLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CodeLock.TryLock of Assembly-CSharp.dll.

Example

object CanLock(BasePlayer BasePlayer , CodeLock CodeLock )
{
    Puts("CanLock was called!");
    return (object) null;
}

CanLock (KeyLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches KeyLock.Lock of Assembly-CSharp.dll.

Example

object CanLock(BasePlayer BasePlayer , KeyLock KeyLock )
{
    Puts("CanLock was called!");
    return (object) null;
}

CanLootEntity (LootableCorpse)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches LootableCorpse.RPC_LootCorpse of Assembly-CSharp.dll.

Example

object CanLootEntity(BasePlayer BasePlayer , LootableCorpse LootableCorpse )
{
    Puts("CanLootEntity was called!");
    return (object) null;
}

CanLootEntity (StorageContainer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StorageContainer.PlayerOpenLoot of Assembly-CSharp.dll.

Example

void CanLootEntity()
{
    Puts("CanLootEntity was called!");
}

CanLootEntity (ResourceContainer)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ResourceContainer.StartLootingContainer of Assembly-CSharp.dll.

Example

object CanLootEntity(BasePlayer BasePlayer , ResourceContainer ResourceContainer )
{
    Puts("CanLootEntity was called!");
    return (object) null;
}

CanLootEntity (DroppedItemContainer)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches DroppedItemContainer.RPC_OpenLoot of Assembly-CSharp.dll.

Example

object CanLootEntity(BasePlayer BasePlayer , DroppedItemContainer DroppedItemContainer )
{
    Puts("CanLootEntity was called!");
    return (object) null;
}

CanLootEntity (BaseRidableAnimal)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseRidableAnimal.RPC_OpenLoot of Assembly-CSharp.dll.

Example

object CanLootEntity(BasePlayer BasePlayer , BaseRidableAnimal BaseRidableAnimal )
{
    Puts("CanLootEntity was called!");
    return (object) null;
}

CanLootEntity (ContainerIOEntity)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ContainerIOEntity.PlayerOpenLoot of Assembly-CSharp.dll.

Example

void CanLootEntity()
{
    Puts("CanLootEntity was called!");
}

CanLootEntity (IndustrialCrafter)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches IndustrialCrafter.PlayerOpenLoot of Assembly-CSharp.dll.

Example

void CanLootEntity()
{
    Puts("CanLootEntity was called!");
}

CanLootPlayer

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.CanBeLooted of Assembly-CSharp.dll.

Example

object CanLootPlayer(BasePlayer BasePlayer )
{
    Puts("CanLootPlayer was called!");
    return (bool) null;
}

CanMountEntity

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.MountPlayer of Assembly-CSharp.dll.

Example

object CanMountEntity(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("CanMountEntity was called!");
    return (object) null;
}

CanNetworkTo

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.ShouldNetworkTo of Assembly-CSharp.dll.

Example

object CanNetworkTo(BasePlayer BasePlayer )
{
    Puts("CanNetworkTo was called!");
    return (bool) null;
}

CanPickupEntity

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseCombatEntity.CanPickup of Assembly-CSharp.dll.

Example

object CanPickupEntity(BasePlayer BasePlayer , BaseCombatEntity BaseCombatEntity )
{
    Puts("CanPickupEntity was called!");
    return (bool) null;
}

CanPickupLock

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseLock.RPC_TakeLock of Assembly-CSharp.dll.

Example

object CanPickupLock(BasePlayer BasePlayer , BaseLock BaseLock )
{
    Puts("CanPickupLock was called!");
    return (object) null;
}

CanPlayerInheritNetworkGroup

• Overrides the IsSpectating check, overriding the result.

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches BasePlayer.ShouldInheritNetworkGroup.

Example

object CanPlayerInheritNetworkGroup(BasePlayer BasePlayer )
{
    Puts("CanPlayerInheritNetworkGroup was called!");
    return (bool) null;
}

CanRenameBed

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches SleepingBag.Rename of Assembly-CSharp.dll.

Example

object CanRenameBed(BasePlayer BasePlayer , SleepingBag SleepingBag , string String )
{
    Puts("CanRenameBed was called!");
    return (object) null;
}

CanResearchItem

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ResearchTable.DoResearch of Assembly-CSharp.dll.

Example

object CanResearchItem(BasePlayer BasePlayer , Item Item )
{
    Puts("CanResearchItem was called!");
    return (object) null;
}

CanSetBedPublic

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches SleepingBag.RPC_MakePublic of Assembly-CSharp.dll.

Example

object CanSetBedPublic(BasePlayer BasePlayer , SleepingBag SleepingBag )
{
    Puts("CanSetBedPublic was called!");
    return (object) null;
}

CanSetRelationship

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches RelationshipManager.SetRelationship of Assembly-CSharp.dll.

Example

object CanSetRelationship(BasePlayer BasePlayer , BasePlayer BasePlayer , RelationshipManager.RelationshipType RelationshipType , int Int32 )
{
    Puts("CanSetRelationship was called!");
    return (object) null;
}

CanSpectateTarget

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.UpdateSpectateTarget of Assembly-CSharp.dll.

Example

object CanSpectateTarget(BasePlayer BasePlayer , string String )
{
    Puts("CanSpectateTarget was called!");
    return (object) null;
}

CanSwapToSeat (BaseMountable)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.CanSwapToThis of Assembly-CSharp.dll.

Example

object CanSwapToSeat(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("CanSwapToSeat was called!");
    return (bool) null;
}

CanSwapToSeat (ModularCarSeat)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ModularCarSeat.CanSwapToThis of Assembly-CSharp.dll.

Example

object CanSwapToSeat(BasePlayer BasePlayer , ModularCarSeat ModularCarSeat )
{
    Puts("CanSwapToSeat was called!");
    return (bool) null;
}

CanTakeCutting

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches GrowableEntity.TakeClones of Assembly-CSharp.dll.

Example

object CanTakeCutting(BasePlayer BasePlayer , GrowableEntity GrowableEntity )
{
    Puts("CanTakeCutting was called!");
    return (object) null;
}

CanUnlock (CodeLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CodeLock.TryUnlock of Assembly-CSharp.dll.

Example

object CanUnlock(BasePlayer BasePlayer , CodeLock CodeLock )
{
    Puts("CanUnlock was called!");
    return (object) null;
}

CanUnlock (KeyLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches KeyLock.RPC_Unlock of Assembly-CSharp.dll.

Example

object CanUnlock(BasePlayer BasePlayer , KeyLock KeyLock )
{
    Puts("CanUnlock was called!");
    return (object) null;
}

CanUnlock (ModularCarCodeLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ModularCarCodeLock.TryOpenWithCode of Assembly-CSharp.dll.

Example

object CanUnlock(BasePlayer BasePlayer , ModularCarCodeLock ModularCarCodeLock , string String )
{
    Puts("CanUnlock was called!");
    return (bool) null;
}

CanUpdateSign (Signage)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Signage.CanUpdateSign of Assembly-CSharp.dll.

Example

object CanUpdateSign(BasePlayer BasePlayer , Signage Signage )
{
    Puts("CanUpdateSign was called!");
    return (bool) null;
}

CanUpdateSign (PhotoFrame)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PhotoFrame.CanUpdateSign of Assembly-CSharp.dll.

Example

object CanUpdateSign(BasePlayer BasePlayer , PhotoFrame PhotoFrame )
{
    Puts("CanUpdateSign was called!");
    return (bool) null;
}

CanUpdateSign (CarvablePumpkin)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CarvablePumpkin.CanUpdateSign of Assembly-CSharp.dll.

Example

object CanUpdateSign(BasePlayer BasePlayer , CarvablePumpkin CarvablePumpkin )
{
    Puts("CanUpdateSign was called!");
    return (bool) null;
}

CanUseGesture

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches GestureConfig.IsOwnedBy of Assembly-CSharp.dll.

Example

object CanUseGesture(BasePlayer BasePlayer , GestureConfig GestureConfig )
{
    Puts("CanUseGesture was called!");
    return (bool) null;
}

CanUseHBHFSensor

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches HBHFSensor.CanUse of Assembly-CSharp.dll.

Example

object CanUseHBHFSensor(BasePlayer BasePlayer , HBHFSensor HBHFSensor )
{
    Puts("CanUseHBHFSensor was called!");
    return (bool) null;
}

CanUseLockedEntity (CodeLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CodeLock.OnTryToOpen of Assembly-CSharp.dll.

Example

object CanUseLockedEntity(BasePlayer BasePlayer , CodeLock CodeLock )
{
    Puts("CanUseLockedEntity was called!");
    return (bool) null;
}

CanUseLockedEntity (CodeLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CodeLock.OnTryToClose of Assembly-CSharp.dll.

Example

object CanUseLockedEntity(BasePlayer BasePlayer , CodeLock CodeLock )
{
    Puts("CanUseLockedEntity was called!");
    return (bool) null;
}

CanUseLockedEntity (KeyLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches KeyLock.OnTryToClose of Assembly-CSharp.dll.

Example

object CanUseLockedEntity(BasePlayer BasePlayer , KeyLock KeyLock )
{
    Puts("CanUseLockedEntity was called!");
    return (bool) null;
}

CanUseLockedEntity (KeyLock)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches KeyLock.OnTryToOpen of Assembly-CSharp.dll.

Example

object CanUseLockedEntity(BasePlayer BasePlayer , KeyLock KeyLock )
{
    Puts("CanUseLockedEntity was called!");
    return (bool) null;
}

CanUseMailbox

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Mailbox.PlayerIsOwner of Assembly-CSharp.dll.

Example

object CanUseMailbox(BasePlayer BasePlayer , Mailbox Mailbox )
{
    Puts("CanUseMailbox was called!");
    return (bool) null;
}

CanUserLogin

• Gets called when a client should or not should join the server.

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnUserApprove.

Example

object CanUserLogin(string String , string String , string String )
{
    Puts("CanUserLogin was called!");
    return (bool) null;
}

CanUseWires

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches WireTool.CanPlayerUseWires of Assembly-CSharp.dll.

Example

object CanUseWires()
{
    Puts("CanUseWires was called!");
    return (bool) null;
}

OnActiveItemChange

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.UpdateActiveItem of Assembly-CSharp.dll.

Example

object OnActiveItemChange(BasePlayer BasePlayer , Item Item , ItemId ItemId )
{
    Puts("OnActiveItemChange was called!");
    return (object) null;
}

OnActiveItemChanged

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.UpdateActiveItem of Assembly-CSharp.dll.

Example

void OnActiveItemChanged(BasePlayer BasePlayer , Item Item , Item Item )
{
    Puts("OnActiveItemChanged was called!");
}

This hook requires OnActiveItemChange, which loads alongside OnActiveItemChanged.

OnClientAuth

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.OnGiveUserInformation of Assembly-CSharp.dll.

Example

void OnClientAuth(Network.Connection Connection )
{
    Puts("OnClientAuth was called!");
}

OnClientCommand

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ConsoleNetwork.OnClientCommand of Assembly-CSharp.dll.

Example

object OnClientCommand(Network.Connection Connection , string String )
{
    Puts("OnClientCommand was called!");
    return (object) null;
}

OnClientDisconnect

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.ReadDisconnectReason of Assembly-CSharp.dll.

Example

void OnClientDisconnect(Network.Connection Connection , string String )
{
    Puts("OnClientDisconnect was called!");
}

OnClientDisconnected

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Server.OnDisconnected of Facepunch.Network.dll.

Example

void OnClientDisconnected(Network.Connection Connection , string String )
{
    Puts("OnClientDisconnected was called!");
}

OnClientProjectileEffectCreate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseProjectile.CreateProjectileEffectClientside of Assembly-CSharp.dll.

Example

object OnClientProjectileEffectCreate(Network.Connection Connection , BaseProjectile BaseProjectile , string String )
{
    Puts("OnClientProjectileEffectCreate was called!");
    return (object) null;
}

OnClothingItemChanged

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerInventory.OnClothingChanged of Assembly-CSharp.dll.

Example

void OnClothingItemChanged(PlayerInventory PlayerInventory , Item Item , bool Boolean )
{
    Puts("OnClothingItemChanged was called!");
}

OnDefaultItemsReceive

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerInventory.GiveDefaultItems of Assembly-CSharp.dll.

Example

object OnDefaultItemsReceive(PlayerInventory PlayerInventory )
{
    Puts("OnDefaultItemsReceive was called!");
    return (object) null;
}

OnDefaultItemsReceived

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerInventory.GiveDefaultItems of Assembly-CSharp.dll.

Example

void OnDefaultItemsReceived(PlayerInventory PlayerInventory )
{
    Puts("OnDefaultItemsReceived was called!");
}

This hook requires OnDefaultItemsReceive, which loads alongside OnDefaultItemsReceived.

OnDemoRecordingStart

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StartDemoRecording of Assembly-CSharp.dll.

Example

object OnDemoRecordingStart(string String , BasePlayer BasePlayer )
{
    Puts("OnDemoRecordingStart was called!");
    return (object) null;
}

OnDemoRecordingStarted

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StartDemoRecording of Assembly-CSharp.dll.

Example

void OnDemoRecordingStarted(string String , BasePlayer BasePlayer )
{
    Puts("OnDemoRecordingStarted was called!");
}

This hook requires OnDemoRecordingStart, which loads alongside OnDemoRecordingStarted.

OnDemoRecordingStop

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StopDemoRecording of Assembly-CSharp.dll.

Example

object OnDemoRecordingStop(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnDemoRecordingStop was called!");
    return (object) null;
}

OnDemoRecordingStopped

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StopDemoRecording of Assembly-CSharp.dll.

Example

void OnDemoRecordingStopped(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnDemoRecordingStopped was called!");
}

This hook requires OnDemoRecordingStop, which loads alongside OnDemoRecordingStopped.

OnEntityMounted

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.MountPlayer of Assembly-CSharp.dll.

Example

void OnEntityMounted(BaseMountable BaseMountable )
{
    Puts("OnEntityMounted was called!");
}

This hook requires CanMountEntity, which loads alongside OnEntityMounted.

OnExperimentEnd

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Workbench.ExperimentComplete of Assembly-CSharp.dll.

Example

object OnExperimentEnd(Workbench Workbench )
{
    Puts("OnExperimentEnd was called!");
    return (object) null;
}

OnExperimentEnded

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Workbench.ExperimentComplete of Assembly-CSharp.dll.

Example

void OnExperimentEnded(Workbench Workbench )
{
    Puts("OnExperimentEnded was called!");
}

This hook requires OnExperimentEnd, which loads alongside OnExperimentEnded.

OnExperimentStart

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Workbench.RPC_BeginExperiment of Assembly-CSharp.dll.

Example

object OnExperimentStart(Workbench Workbench , BasePlayer BasePlayer )
{
    Puts("OnExperimentStart was called!");
    return (object) null;
}

OnExperimentStarted

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Workbench.RPC_BeginExperiment of Assembly-CSharp.dll.

Example

void OnExperimentStarted(Workbench Workbench , BasePlayer BasePlayer )
{
    Puts("OnExperimentStarted was called!");
}

This hook requires OnExperimentStart, which loads alongside OnExperimentStarted.

OnEyePosValidate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches AttackEntity.ValidateEyePos of Assembly-CSharp.dll.

Example

object OnEyePosValidate(AttackEntity AttackEntity , BasePlayer BasePlayer , UnityEngine.Vector3 Vector3 , bool Boolean )
{
    Puts("OnEyePosValidate was called!");
    return (bool) null;
}

OnFeedbackReported

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnFeedbackReport of Assembly-CSharp.dll.

Example

void OnFeedbackReported(BasePlayer BasePlayer , string String , string String , Facepunch.Models.ReportType ReportType )
{
    Puts("OnFeedbackReported was called!");
}

OnFindSpawnPoint

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.FindSpawnPoint of Assembly-CSharp.dll.

Example

object OnFindSpawnPoint()
{
    Puts("OnFindSpawnPoint was called!");
    return (BasePlayer.SpawnPoint) null;
}

OnInventoryNetworkUpdate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerInventory.SendUpdatedInventoryInternal of Assembly-CSharp.dll.

Example

object OnInventoryNetworkUpdate(PlayerInventory PlayerInventory , ItemContainer ItemContainer , ProtoBuf.UpdateItemContainer UpdateItemContainer , PlayerInventory.Type Type , PlayerInventory.NetworkInventoryMode NetworkInventoryMode )
{
    Puts("OnInventoryNetworkUpdate was called!");
    return (object) null;
}

OnLootEntity

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerLoot.StartLootingEntity of Assembly-CSharp.dll.

Example

void OnLootEntity(PlayerLoot PlayerLoot , BaseEntity BaseEntity )
{
    Puts("OnLootEntity was called!");
}

OnLootEntityEnd (LootableCorpse)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches LootableCorpse.PlayerStoppedLooting of Assembly-CSharp.dll.

Example

void OnLootEntityEnd(BasePlayer BasePlayer , LootableCorpse LootableCorpse )
{
    Puts("OnLootEntityEnd was called!");
}

OnLootEntityEnd (StorageContainer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StorageContainer.PlayerStoppedLooting of Assembly-CSharp.dll.

Example

void OnLootEntityEnd(BasePlayer BasePlayer , StorageContainer StorageContainer )
{
    Puts("OnLootEntityEnd was called!");
}

OnLootEntityEnd (DroppedItemContainer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches DroppedItemContainer.PlayerStoppedLooting of Assembly-CSharp.dll.

Example

void OnLootEntityEnd(BasePlayer BasePlayer , DroppedItemContainer DroppedItemContainer )
{
    Puts("OnLootEntityEnd was called!");
}

OnLootEntityEnd (ContainerIOEntity)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ContainerIOEntity.PlayerStoppedLooting of Assembly-CSharp.dll.

Example

void OnLootEntityEnd(BasePlayer BasePlayer , ContainerIOEntity ContainerIOEntity )
{
    Puts("OnLootEntityEnd was called!");
}

OnLootEntityEnd (ItemBasedFlowRestrictor)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ItemBasedFlowRestrictor.PlayerStoppedLooting of Assembly-CSharp.dll.

Example

void OnLootEntityEnd(BasePlayer BasePlayer , ItemBasedFlowRestrictor ItemBasedFlowRestrictor )
{
    Puts("OnLootEntityEnd was called!");
}

OnLootItem

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerLoot.StartLootingItem of Assembly-CSharp.dll.

Example

void OnLootItem(PlayerLoot PlayerLoot , Item Item )
{
    Puts("OnLootItem was called!");
}

OnLootNetworkUpdate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerLoot.SendUpdate of Assembly-CSharp.dll.

Example

object OnLootNetworkUpdate(PlayerLoot PlayerLoot )
{
    Puts("OnLootNetworkUpdate was called!");
    return (object) null;
}

OnLootPlayer

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RPC_LootPlayer of Assembly-CSharp.dll.

Example

void OnLootPlayer(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnLootPlayer was called!");
}

OnMapMarkerAdd

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Server_AddMarker of Assembly-CSharp.dll.

Example

void OnMapMarkerAdd()
{
    Puts("OnMapMarkerAdd was called!");
}

OnMapMarkerAdded

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Server_AddMarker of Assembly-CSharp.dll.

Example

void OnMapMarkerAdded(BasePlayer BasePlayer , ProtoBuf.MapNote MapNote )
{
    Puts("OnMapMarkerAdded was called!");
}

This hook requires OnMapMarkerAdd, which loads alongside OnMapMarkerAdded.

OnMapMarkerRemove

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Server_RemovePointOfInterest of Assembly-CSharp.dll.

Example

object OnMapMarkerRemove(BasePlayer BasePlayer , BasePlayer BasePlayer , int Int32 )
{
    Puts("OnMapMarkerRemove was called!");
    return (object) null;
}

OnMapMarkersClear

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Server_ClearMapMarkers of Assembly-CSharp.dll.

Example

object OnMapMarkersClear(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnMapMarkersClear was called!");
    return (object) null;
}

OnMapMarkersCleared

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Server_ClearMapMarkers of Assembly-CSharp.dll.

Example

void OnMapMarkersCleared(BasePlayer BasePlayer )
{
    Puts("OnMapMarkersCleared was called!");
}

This hook requires OnMapMarkersClear, which loads alongside OnMapMarkersCleared.

OnMeleeAttack

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMelee.PlayerAttack of Assembly-CSharp.dll.

Example

object OnMeleeAttack(BasePlayer BasePlayer , HitInfo HitInfo )
{
    Puts("OnMeleeAttack was called!");
    return (object) null;
}

OnMetalDetectorFlagRequest

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMetalDetector.RPC_RequestFlag of Assembly-CSharp.dll.

Example

void OnMetalDetectorFlagRequest(BaseMetalDetector BaseMetalDetector , UnityEngine.Vector3 Vector3 , BasePlayer BasePlayer )
{
    Puts("OnMetalDetectorFlagRequest was called!");
}

OnPayForPlacement

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Planner.PayForPlacement of Assembly-CSharp.dll.

Example

object OnPayForPlacement(BasePlayer BasePlayer , Planner Planner , Construction Construction )
{
    Puts("OnPayForPlacement was called!");
    return (object) null;
}

OnPayForUpgrade

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BuildingBlock.PayForUpgrade of Assembly-CSharp.dll.

Example

object OnPayForUpgrade(BasePlayer BasePlayer , BuildingBlock BuildingBlock , ConstructionGrade ConstructionGrade )
{
    Puts("OnPayForUpgrade was called!");
    return (object) null;
}

OnPlayerAddModifiers

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ItemModConsume.DoAction of Assembly-CSharp.dll.

Example

void OnPlayerAddModifiers()
{
    Puts("OnPlayerAddModifiers was called!");
}

OnPlayerAssist

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RPC_Assist of Assembly-CSharp.dll.

Example

object OnPlayerAssist(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerAssist was called!");
    return (object) null;
}

OnPlayerAttack (BaseMelee)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMelee.DoAttackShared of Assembly-CSharp.dll.

Example

object OnPlayerAttack(BaseMelee BaseMelee , HitInfo HitInfo )
{
    Puts("OnPlayerAttack was called!");
    return (object) null;
}

OnPlayerAttack (BasePlayer)

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnProjectileAttack of Assembly-CSharp.dll.

Example

object OnPlayerAttack(BasePlayer BasePlayer , HitInfo HitInfo )
{
    Puts("OnPlayerAttack was called!");
    return (object) null;
}

OnPlayerBanned (EACServer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches EACServer.OnClientActionRequired of Assembly-CSharp.dll.

Example

void OnPlayerBanned(Network.Connection Connection , string String )
{
    Puts("OnPlayerBanned was called!");
}

OnPlayerBanned (CorePlugin)

• Gets called when a connection gets banned.

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CorePlugin.IOnPlayerBanned.

Example

void OnPlayerBanned(Network.Connection Connection , string String )
{
    Puts("OnPlayerBanned was called!");
}

OnPlayerChat

• Gets called when a player sends a chat message.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnPlayerChat.

Example

void OnPlayerChat(BasePlayer BasePlayer , string String , ConVar.Chat.ChatChannel ChatChannel )
{
    Puts("OnPlayerChat was called!");
}

OnPlayerColliderEnable

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.EnablePlayerCollider of Assembly-CSharp.dll.

Example

object OnPlayerColliderEnable(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerColliderEnable was called!");
    return (object) null;
}

OnPlayerConnected

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnPlayerConnected.

Example

void OnPlayerConnected(BasePlayer BasePlayer )
{
    Puts("OnPlayerConnected was called!");
}

OnPlayerCorpseSpawn

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.CreateCorpse of Assembly-CSharp.dll.

Example

void OnPlayerCorpseSpawn()
{
    Puts("OnPlayerCorpseSpawn was called!");
}

OnPlayerCorpseSpawned

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.CreateCorpse of Assembly-CSharp.dll.

Example

void OnPlayerCorpseSpawned(BasePlayer BasePlayer , PlayerCorpse PlayerCorpse )
{
    Puts("OnPlayerCorpseSpawned was called!");
}

This hook requires OnPlayerCorpseSpawn, which loads alongside OnPlayerCorpseSpawned.

OnPlayerDeath

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Die of Assembly-CSharp.dll.

Example

object OnPlayerDeath(BasePlayer BasePlayer , HitInfo HitInfo )
{
    Puts("OnPlayerDeath was called!");
    return (object) null;
}

OnPlayerDig

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseDiggableEntity.Dig of Assembly-CSharp.dll.

Example

object OnPlayerDig(BasePlayer BasePlayer , BaseDiggableEntity BaseDiggableEntity )
{
    Puts("OnPlayerDig was called!");
    return (object) null;
}

OnPlayerDisconnected

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.OnDisconnected of Assembly-CSharp.dll.

Example

void OnPlayerDisconnected(BasePlayer BasePlayer , string String )
{
    Puts("OnPlayerDisconnected was called!");
}

OnPlayerDismountFailed

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.RPC_WantsDismount of Assembly-CSharp.dll.

Example

void OnPlayerDismountFailed(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("OnPlayerDismountFailed was called!");
}

This hook requires OnPlayerWantsDismount, which loads alongside OnPlayerDismountFailed.

OnPlayerDrink

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches LiquidContainer.SVDrink of Assembly-CSharp.dll.

Example

object OnPlayerDrink(BasePlayer BasePlayer , LiquidContainer LiquidContainer )
{
    Puts("OnPlayerDrink was called!");
    return (object) null;
}

OnPlayerDropActiveItem

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerBelt.DropActive of Assembly-CSharp.dll.

Example

object OnPlayerDropActiveItem(PlayerBelt PlayerBelt , Item Item )
{
    Puts("OnPlayerDropActiveItem was called!");
    return (object) null;
}

OnPlayerHandcuff

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Handcuffs.SV_HandcuffVictim of Assembly-CSharp.dll.

Example

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

OnPlayerHandcuffed

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Handcuffs.SV_HandcuffVictim of Assembly-CSharp.dll.

Example

void OnPlayerHandcuffed()
{
    Puts("OnPlayerHandcuffed was called!");
}

This hook requires OnPlayerHandcuff, which loads alongside OnPlayerHandcuffed.

OnPlayerHealthChange

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnHealthChanged of Assembly-CSharp.dll.

Example

object OnPlayerHealthChange(BasePlayer BasePlayer , float Single , float Single )
{
    Puts("OnPlayerHealthChange was called!");
    return (object) null;
}

OnPlayerInput

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnReceiveTick of Assembly-CSharp.dll.

Example

object OnPlayerInput(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerInput was called!");
    return (object) null;
}

This hook requires OnPlayerTick, which loads alongside OnPlayerInput.

OnPlayerKeepAlive

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RPC_KeepAlive of Assembly-CSharp.dll.

Example

object OnPlayerKeepAlive(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerKeepAlive was called!");
    return (object) null;
}

OnPlayerKicked (BasePlayer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Kick of Assembly-CSharp.dll.

Example

void OnPlayerKicked(BasePlayer BasePlayer )
{
    Puts("OnPlayerKicked was called!");
}

OnPlayerKicked (EACServer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches EACServer.OnClientActionRequired of Assembly-CSharp.dll.

Example

void OnPlayerKicked(Network.Connection Connection , string String )
{
    Puts("OnPlayerKicked was called!");
}

This hook requires OnPlayerBanned [EAC], which loads alongside OnPlayerKicked.

OnPlayerLand

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.ApplyFallDamageFromVelocity of Assembly-CSharp.dll.

Example

object OnPlayerLand(BasePlayer BasePlayer , float Single )
{
    Puts("OnPlayerLand was called!");
    return (object) null;
}

OnPlayerLanded

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.ApplyFallDamageFromVelocity of Assembly-CSharp.dll.

Example

void OnPlayerLanded(BasePlayer BasePlayer , float Single )
{
    Puts("OnPlayerLanded was called!");
}

This hook requires OnPlayerLand, which loads alongside OnPlayerLanded.

OnPlayerLootEnd

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerLoot.Clear of Assembly-CSharp.dll.

Example

void OnPlayerLootEnd(PlayerLoot PlayerLoot )
{
    Puts("OnPlayerLootEnd was called!");
}

OnPlayerMarkersSend

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.SendMarkersToClient of Assembly-CSharp.dll.

Example

void OnPlayerMarkersSend(BasePlayer BasePlayer , ProtoBuf.MapNoteList MapNoteList )
{
    Puts("OnPlayerMarkersSend was called!");
}

OnPlayerMetabolize

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerMetabolism.ServerUpdate of Assembly-CSharp.dll.

Example

void OnPlayerMetabolize(PlayerMetabolism PlayerMetabolism , BaseCombatEntity BaseCombatEntity , float Single )
{
    Puts("OnPlayerMetabolize was called!");
}

OnPlayerOfflineChat

• Gets called when a player sends an offline chat message.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.OnPlayerOfflineChat.

Example

void OnPlayerOfflineChat(ulong UInt64 , string String , string String , ConVar.Chat.ChatChannel ChatChannel )
{
    Puts("OnPlayerOfflineChat was called!");
}

OnPlayerPingsSend

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.SendPingsToClient of Assembly-CSharp.dll.

Example

void OnPlayerPingsSend(BasePlayer BasePlayer , ProtoBuf.MapNoteList MapNoteList )
{
    Puts("OnPlayerPingsSend was called!");
}

OnPlayerRecover

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RecoverFromWounded of Assembly-CSharp.dll.

Example

object OnPlayerRecover(BasePlayer BasePlayer )
{
    Puts("OnPlayerRecover was called!");
    return (object) null;
}

OnPlayerRecovered

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RecoverFromWounded of Assembly-CSharp.dll.

Example

void OnPlayerRecovered(BasePlayer BasePlayer )
{
    Puts("OnPlayerRecovered was called!");
}

This hook requires OnPlayerRecover, which loads alongside OnPlayerRecovered.

OnPlayerReported

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnPlayerReported of Assembly-CSharp.dll.

Example

void OnPlayerReported(BasePlayer BasePlayer , string String , string String , string String , string String , string String )
{
    Puts("OnPlayerReported was called!");
}

OnPlayerRespawn (BasePlayer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.Respawn of Assembly-CSharp.dll.

Example

void OnPlayerRespawn(BasePlayer player, BasePlayer.SpawnPoint spawnPoint)
{
    Puts("OnPlayerRespawn was called!");
}

OnPlayerRespawn (SleepingBag)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches SleepingBag.SpawnPlayer of Assembly-CSharp.dll.

Example

void OnPlayerRespawn(BasePlayer player, BasePlayer.SpawnPoint spawnPoint)
{
    Puts("OnPlayerRespawn was called!");
}

OnPlayerRespawned

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.RespawnAt of Assembly-CSharp.dll.

Example

void OnPlayerRespawned(BasePlayer BasePlayer )
{
    Puts("OnPlayerRespawned was called!");
}

OnPlayerRevive

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches MedicalTool.GiveEffectsTo of Assembly-CSharp.dll.

Example

object OnPlayerRevive(MedicalTool MedicalTool , BasePlayer BasePlayer )
{
    Puts("OnPlayerRevive was called!");
    return (object) null;
}

This hook requires OnHealingItemUse, which loads alongside OnPlayerRevive.

OnPlayerSetInfo (ServerMgr)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.ClientReady of Assembly-CSharp.dll.

Example

void OnPlayerSetInfo(Network.Connection Connection , string String , string String )
{
    Puts("OnPlayerSetInfo was called!");
}

OnPlayerSetInfo (BasePlayer)

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.SetInfo of Assembly-CSharp.dll.

Example

void OnPlayerSetInfo(BasePlayer BasePlayer , string String , string String )
{
    Puts("OnPlayerSetInfo was called!");
}

OnPlayerSleep

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StartSleeping of Assembly-CSharp.dll.

Example

void OnPlayerSleep(BasePlayer BasePlayer )
{
    Puts("OnPlayerSleep was called!");
}

OnPlayerSleepEnd

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.EndSleeping of Assembly-CSharp.dll.

Example

object OnPlayerSleepEnd(BasePlayer BasePlayer )
{
    Puts("OnPlayerSleepEnd was called!");
    return (object) null;
}

OnPlayerSleepEnded

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.EndSleeping of Assembly-CSharp.dll.

Example

void OnPlayerSleepEnded(BasePlayer BasePlayer )
{
    Puts("OnPlayerSleepEnded was called!");
}

This hook requires OnPlayerSleepEnd, which loads alongside OnPlayerSleepEnded.

OnPlayerSpawn

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerMgr.SpawnNewPlayer of Assembly-CSharp.dll.

Example

void OnPlayerSpawn()
{
    Puts("OnPlayerSpawn was called!");
}

OnPlayerSpectate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StartSpectating of Assembly-CSharp.dll.

Example

object OnPlayerSpectate(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerSpectate was called!");
    return (object) null;
}

OnPlayerSpectateEnd

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.StopSpectating of Assembly-CSharp.dll.

Example

object OnPlayerSpectateEnd(BasePlayer BasePlayer , BasePlayer BasePlayer )
{
    Puts("OnPlayerSpectateEnd was called!");
    return (object) null;
}

OnPlayerStudyBlueprint

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ItemModStudyBlueprint.ServerCommand of Assembly-CSharp.dll.

Example

object OnPlayerStudyBlueprint(BasePlayer BasePlayer , Item Item )
{
    Puts("OnPlayerStudyBlueprint was called!");
    return (object) null;
}

OnPlayerTick

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnReceiveTick of Assembly-CSharp.dll.

Example

object OnPlayerTick(BasePlayer BasePlayer )
{
    Puts("OnPlayerTick was called!");
    return (object) null;
}

OnPlayerViolation

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches AntiHack.AddViolation of Assembly-CSharp.dll.

Example

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

OnPlayerVoice

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.OnReceivedVoice of Assembly-CSharp.dll.

Example

object OnPlayerVoice(BasePlayer BasePlayer )
{
    Puts("OnPlayerVoice was called!");
    return (object) null;
}

OnPlayerWantsDismount

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.RPC_WantsDismount of Assembly-CSharp.dll.

Example

object OnPlayerWantsDismount(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("OnPlayerWantsDismount was called!");
    return (object) null;
}

OnPlayerWantsMount

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseMountable.WantsMount of Assembly-CSharp.dll.

Example

object OnPlayerWantsMount(BasePlayer BasePlayer , BaseMountable BaseMountable )
{
    Puts("OnPlayerWantsMount was called!");
    return (object) null;
}

OnPlayerWound

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.BecomeWounded of Assembly-CSharp.dll.

Example

object OnPlayerWound(BasePlayer BasePlayer , HitInfo HitInfo )
{
    Puts("OnPlayerWound was called!");
    return (object) null;
}

OnPortalUse

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePortal.UsePortal of Assembly-CSharp.dll.

Example

object OnPortalUse(BasePlayer BasePlayer , BasePortal BasePortal )
{
    Puts("OnPortalUse was called!");
    return (object) null;
}

OnPortalUsed

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePortal.UsePortal of Assembly-CSharp.dll.

Example

void OnPortalUsed(BasePlayer BasePlayer , BasePortal BasePortal )
{
    Puts("OnPortalUsed was called!");
}

This hook requires OnPortalUse, which loads alongside OnPortalUsed.

OnRespawnInformationGiven

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.SendRespawnOptions of Assembly-CSharp.dll.

Example

void OnRespawnInformationGiven(BasePlayer BasePlayer , System.Collections.Generic.List`1[[ProtoBuf.RespawnInformation.SpawnOptions, Rust.Data, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] List`1 )
{
    Puts("OnRespawnInformationGiven was called!");
}

OnRunPlayerMetabolism

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PlayerMetabolism.RunMetabolism of Assembly-CSharp.dll.

Example

object OnRunPlayerMetabolism(PlayerMetabolism PlayerMetabolism )
{
    Puts("OnRunPlayerMetabolism was called!");
    return (object) null;
}

OnSendModelState

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.SendModelState of Assembly-CSharp.dll.

Example

void OnSendModelState()
{
    Puts("OnSendModelState was called!");
}

OnSignalBroadcast

• No return behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseEntity.SignalBroadcast of Assembly-CSharp.dll.

Example

void OnSignalBroadcast()
{
    Puts("OnSignalBroadcast was called!");
}

OnSpinWheel

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches SpinnerWheel.RPC_Spin of Assembly-CSharp.dll.

Example

object OnSpinWheel(BasePlayer BasePlayer , SpinnerWheel SpinnerWheel )
{
    Puts("OnSpinWheel was called!");
    return (object) null;
}

OnThreatLevelUpdate

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BasePlayer.EnsureUpdated of Assembly-CSharp.dll.

Example

object OnThreatLevelUpdate(BasePlayer BasePlayer )
{
    Puts("OnThreatLevelUpdate was called!");
    return (object) null;
}

OnUserApprove

• Gets called when a connection is or not approved to join the server.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnUserApprove.

Example

void OnUserApprove(Network.Connection Connection )
{
    Puts("OnUserApprove was called!");
}

OnUserApproved

• Gets called when a connection is approved to join the server.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnUserApprove.

Example

void OnUserApproved(string String , string String , string String )
{
    Puts("OnUserApproved was called!");
}

OnUserChat

• Gets called when a player sends a chat message.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnPlayerChat.

Example

void OnUserChat(Oxide.Core.Libraries.Covalence.IPlayer IPlayer , string String )
{
    Puts("OnUserChat was called!");
}

OnUserConnected

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnPlayerConnected.

Example

void OnUserConnected(Oxide.Core.Libraries.Covalence.IPlayer IPlayer )
{
    Puts("OnUserConnected was called!");
}

OnUserKicked

• Gets called when a covalence player gets kicked.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.OnPlayerKicked.

Example

void OnUserKicked(Oxide.Core.Libraries.Covalence.IPlayer IPlayer , string String )
{
    Puts("OnUserKicked was called!");
}

OnUserRespawn

• Gets called when a covalence player respawns.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.OnPlayerRespawn.

Example

void OnUserRespawn(Oxide.Core.Libraries.Covalence.IPlayer IPlayer )
{
    Puts("OnUserRespawn was called!");
}

OnUserRespawned

• Gets called when a covalence player fully respawned.

• No return behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.OnPlayerRespawned.

Example

void OnUserRespawned(Oxide.Core.Libraries.Covalence.IPlayer IPlayer )
{
    Puts("OnUserRespawned was called!");
}

OnWireClear

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches WireTool.AttemptClearSlot of Assembly-CSharp.dll.

Example

object OnWireClear(BasePlayer BasePlayer , IOEntity IOEntity , int Int32 , bool Boolean )
{
    Puts("OnWireClear was called!");
    return (object) null;
}

This hook requires OnWireClear [patch], which loads alongside OnWireClear.

OnWireConnect

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches WireTool.RPC_MakeConnection of Assembly-CSharp.dll.

Example

object OnWireConnect(BasePlayer BasePlayer , IOEntity IOEntity , int Int32 , IOEntity IOEntity , int Int32 , System.Collections.Generic.List`1[[UnityEngine.Vector3, UnityEngine.CoreModule, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] List`1 , System.Collections.Generic.List`1[[System.Single, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] List`1 )
{
    Puts("OnWireConnect was called!");
    return (object) null;
}