RustTip

CanNpcEat

OxideNPC
object CanNpcEat(BaseNpc baseNpc, BaseEntity best)
Works — the game method in this build is the one the hook was written for.

Parameters

baseNpc
BaseNpc
best
BaseEntity

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 CanNpcEat(BaseNpc baseNpc, BaseEntity best)
{
    Puts("CanNpcEat");

    // 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)
bool BaseNpc.WantsToEat(BaseEntity)

Passes: BaseNpc baseNpc, BaseEntity best

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public virtual bool WantsToEat(BaseEntity best)
{
	object returnvar = Interface.CallHook("CanNpcEat", this, best);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (!best.HasTrait(TraitFlag.Food))
	{
		return false;
	}
// …

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.