OnPlayerDigComplete

OxideCarbonPlayer

object OnPlayerDigComplete(BasePlayer player, BaseDiggableEntity baseDiggableEntity)
object OnPlayerDigComplete(BasePlayer player, MetalDetectorFlag metalDetectorFlag)

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 OnPlayerDigComplete(BasePlayer player, BaseDiggableEntity baseDiggableEntity)
{
    Puts("OnPlayerDigComplete");

    // 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 1

Rust.opj (Oxide)

void BaseDiggableEntity.OnFullyDug(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 OnFullyDug(BasePlayer player)
{
	if (Interface.CallHook("OnPlayerDigComplete", player, this) != null)
	{
		return;
	}
	SpawnLootListItem(player);
}

Injection point 2

Rust.opj (Oxide)

void MetalDetectorFlag.OnFullyDug(BasePlayer)

Passes: BasePlayer player, MetalDetectorFlag metalDetectorFlag

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

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

public override void OnFullyDug(BasePlayer player)
{
	if (Interface.CallHook("OnPlayerDigComplete", player, this) != null)
	{
		return;
	}
	if (Collision != null)
	{
		Collision.enabled = false;
	}
	BaseEntity baseEntity = SpawnLootListItem(player);
// …

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.