Structure (40)

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.

CanAffordToPlace

• Useful for ignoring resource requirements for placement.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

CanAffordUpgrade

• Called when the resources for an upgrade are checked.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

object CanAffordUpgrade(BasePlayer BasePlayer , BuildingBlock BuildingBlock , BuildingGrade.Enum Enum , ulong UInt64 )
{
    Puts("CanAffordUpgrade was called!");
    return (bool) null;
}

CanBuild

• Called when the player tries to build something.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

object CanBuild(Planner Planner , Construction Construction , Construction.Target Target )
{
    Puts("CanBuild was called!");
    return (object) null;
}

CanChangeGrade

• Called when a player tries to change a building grade.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

object CanChangeGrade(BasePlayer BasePlayer , BuildingBlock BuildingBlock , BuildingGrade.Enum Enum , ulong UInt64 )
{
    Puts("CanChangeGrade was called!");
    return (bool) null;
}

CanDemolish

• Called when a player tries to demolish a building block.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StabilityEntity.CanDemolish of Assembly-CSharp.dll.

Example

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

OnBuildingMerge

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerBuildingManager.Merge of Assembly-CSharp.dll.

Example

void OnBuildingMerge(ServerBuildingManager ServerBuildingManager )
{
    Puts("OnBuildingMerge was called!");
}

OnBuildingSplit

• Called when a building is split into two.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ServerBuildingManager.Split of Assembly-CSharp.dll.

Example

void OnBuildingSplit(BuildingManager.Building Building , uint UInt32 )
{
    Puts("OnBuildingSplit was called!");
}

OnCodeChanged

• 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

void OnCodeChanged(BasePlayer BasePlayer , CodeLock CodeLock , string String , bool Boolean )
{
    Puts("OnCodeChanged was called!");
}

This hook requires CanChangeCode, which loads alongside OnCodeChanged.

OnCodeEntered

• Called when the player has entered a code in a codelock.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnConstructionPlace

• Called when a player tries to place a building block.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnCupboardAssign

• Called when a player is assigned to a cupboard.

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches CorePlugin.IOnCupboardAuthorize of Carbon.Common.dll.

Example

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

OnCupboardAuthorize (ItemModDeployable)

• Called when a cupboard attempts to authorize a player.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches ItemModDeployable.OnDeployed of Assembly-CSharp.dll.

Example

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

OnCupboardAuthorize (CorePlugin)

• Called when a cupboard attempts to authorize a player.

• Called when a cupboard attempts to authorize a player.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches CorePlugin.IOnCupboardAuthorize of Carbon.Common.dll.

Example

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

OnCupboardClearList

• Called when an attempt is made to clear a cupboard authorized list.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BuildingPrivlidge.ClearList of Assembly-CSharp.dll.

Example

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

OnCupboardDeauthorize

• Called when a cupboard attempts to deauthorize a player.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BuildingPrivlidge.RemoveSelfAuthorize of Assembly-CSharp.dll.

Example

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

OnCupboardProtectionCalculated

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BuildingPrivlidge.GetProtectedMinutes of Assembly-CSharp.dll.

Example

void OnCupboardProtectionCalculated(BuildingPrivlidge BuildingPrivlidge , BuildingPrivlidge BuildingPrivlidge )
{
    Puts("OnCupboardProtectionCalculated was called!");
}

OnDoorClosed

• Called when the player closed a door.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Door.RPC_CloseDoor of Assembly-CSharp.dll.

Example

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

OnDoorKnocked (Door)

• Called when the player knocks on a door.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Door.RPC_KnockDoor of Assembly-CSharp.dll.

Example

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

OnDoorKnocked (DoorKnocker)

• Called when the player knocks on a door.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches DoorKnocker.Knock of Assembly-CSharp.dll.

Example

void OnDoorKnocked(DoorKnocker DoorKnocker )
{
    Puts("OnDoorKnocked was called!");
}

OnDoorOpened

• Called when the player opened a door.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Door.RPC_OpenDoor of Assembly-CSharp.dll.

Example

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

OnEntityBuilt

• Called when any structure is built (walls, ceilings, stairs, etc.).

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

void OnEntityBuilt(Planner Planner , UnityEngine.GameObject GameObject )
{
    Puts("OnEntityBuilt was called!");
}

OnHammerHit

• Called when the player has hit something with a hammer.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnLockerSwap

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Locker.RPC_Equip of Assembly-CSharp.dll.

Example

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

OnPlayerPveDamage

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

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

Example

object OnPlayerPveDamage(BaseEntity BaseEntity , HitInfo HitInfo , BuildingBlock BuildingBlock )
{
    Puts("OnPlayerPveDamage was called!");
    return (object) null;
}

OnPoweredLightsPointAdd

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches PoweredLightsDeployer.AddPoint of Assembly-CSharp.dll.

Example

object OnPoweredLightsPointAdd(PoweredLightsDeployer PoweredLightsDeployer , BasePlayer BasePlayer , UnityEngine.Vector3 Vector3 , UnityEngine.Vector3 Vector3 )
{
    Puts("OnPoweredLightsPointAdd was called!");
    return (object) null;
}

OnSignContentCopied

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches SignContent.CopyInfoToSign of Assembly-CSharp.dll.

Example

void OnSignContentCopied(SignContent SignContent , ISignage ISignage , IUGCBrowserEntity IUGCBrowserEntity )
{
    Puts("OnSignContentCopied was called!");
}

OnSignLocked (Signage)

• Called after the player has locked a sign or photo frame.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnSignLocked (PhotoFrame)

• Called after the player has locked a sign or photo frame.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnSignUpdated (Signage)

• Called after the player has changed the text on a sign or updated a photo frame.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

void OnSignUpdated(Signage Signage , BasePlayer BasePlayer , int Int32 )
{
    Puts("OnSignUpdated was called!");
}

OnSignUpdated (PhotoFrame)

• Called after the player has changed the text on a sign or updated a photo frame.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnSignUpdated (CarvablePumpkin)

• Called after the player has changed the text on a sign or updated a photo frame.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnStructureDemolish (StabilityEntity)

• Called when the player selects Demolish or DemolishImmediate from the BuildingBlock or BaseCombatEntity menu.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StabilityEntity.DoImmediateDemolish of Assembly-CSharp.dll.

Example

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

OnStructureDemolish (StabilityEntity)

• Called when the player selects Demolish or DemolishImmediate from the BuildingBlock or BaseCombatEntity menu.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches StabilityEntity.DoDemolish of Assembly-CSharp.dll.

Example

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

OnStructureRepair

• Called when the player repairs a BuildingBlock or BaseCombatEntity.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnStructureRotate

• Called when the player rotates a BuildingBlock or BaseCombatEntity.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

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

OnStructureUpgrade

• Called when the player upgrades the grade of a BuildingBlock or BaseCombatEntity.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

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

Example

object OnStructureUpgrade(BuildingBlock BuildingBlock , BasePlayer BasePlayer , BuildingGrade.Enum Enum , ulong UInt64 )
{
    Puts("OnStructureUpgrade was called!");
    return (object) null;
}

OnStructureUpgraded

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

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

Example

void OnStructureUpgraded(BuildingBlock BuildingBlock , BasePlayer BasePlayer , BuildingGrade.Enum Enum , ulong UInt64 )
{
    Puts("OnStructureUpgraded was called!");
}

This hook requires OnStructureUpgrade, which loads alongside OnStructureUpgraded.

OnWallpaperRemove

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

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

Example

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

OnWallpaperSet

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

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

Example

object OnWallpaperSet(BuildingBlock BuildingBlock , ulong UInt64 , int Int32 )
{
    Puts("OnWallpaperSet was called!");
    return (object) null;
}