RustTip

OnExplosiveDud

OxideCarbonWeapon

Called when explosive dud occurs.

object OnExplosiveDud(DudTimedExplosive dudTimedExplosive)
Works — the game method in this build is the one the hook was written for.

Parameters

dudTimedExplosive
DudTimedExplosive

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnExplosiveDud(DudTimedExplosive dudTimedExplosive)
{
    Puts("OnExplosiveDud");

    // 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 DudTimedExplosive.Explode()

Passes: DudTimedExplosive dudTimedExplosive

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

public override void Explode()
{
	if (creatorEntity != null && creatorEntity.IsNpc)
	{
		base.Explode();
	}
	else if (Random.Range(0f, 1f) < dudChance)
	{
		if (Interface.CallHook("OnExplosiveDud", this) == null)
		{
			return;
		}
		BecomeDud();
	}
	else
	{
		base.Explode();
// …

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.