OnEntityActiveCheck

OxideCarbonEntity

Called when entity active check occurs.

object OnEntityActiveCheck(BaseEntity ent, BasePlayer player, uint id, string debugName)

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

Parameters

ent: BaseEntity
player: BasePlayer
id: uint
debugName: string

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnEntityActiveCheck(BaseEntity ent, BasePlayer player, uint id, string debugName)
{
    Puts("OnEntityActiveCheck");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool BaseEntity.RPC_Server.IsActiveItem.Test(uint, string, BaseEntity, BasePlayer)

Passes: BaseEntity ent, BasePlayer player, uint id, string debugName

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a2, a3, a0, a1)Assembly-CSharp.dll

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

// …
if (ent == null || player == null)
{
	return false;
}
if (ent.net == null || player.net == null)
{
	return false;
}
object returnvar = Interface.CallHook("OnEntityActiveCheck", ent, player, id, debugName);
if (returnvar is bool)
{
	return (bool)returnvar;
}
if (ent.net.ID == player.net.ID)
{
	return true;
}
// …

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.