OnNpcDuck

OxideNPC

object OnNpcDuck(HumanNPC humanNPC)

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

Parameters

humanNPC: HumanNPC

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object OnNpcDuck(HumanNPC humanNPC)
{
    Puts("OnNpcDuck");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point

Rust.opj (Oxide)

void HumanNPC.SetDucked(bool)

Passes: HumanNPC humanNPC

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void SetDucked(bool flag)
{
	if (Interface.CallHook("OnNpcDuck", this) != null)
	{
		return;
	}
	modelState.ducked = flag;
	SendNetworkUpdate();
}

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.