OnPlayerDig

OxideCarbonPlayer

Called when player dig occurs.

object OnPlayerDig(BasePlayer player, BaseDiggableEntity baseDiggableEntity)

Works — the game method in this build is the one the hook was written for.

Parameters

player: BasePlayer
baseDiggableEntity: BaseDiggableEntity

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnPlayerDig(BasePlayer player, BaseDiggableEntity baseDiggableEntity)
{
    Puts("OnPlayerDig");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

void BaseDiggableEntity.Dig(BasePlayer)

Passes: BasePlayer player, BaseDiggableEntity baseDiggableEntity

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

Where it is called (this branch's game code)

public virtual void Dig(BasePlayer player)
{
	if (Interface.CallHook("OnPlayerDig", player, this) != null)
	{
		return;
	}
	if (digsRemaining == RequiredDigCount)
	{
		OnFirstDig(player);
	}
	ClientRPC(RpcTarget.NetworkGroup("RPC_OnDig"), RequiredDigCount - digsRemaining, RequiredDigCount);
// …

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.