OnEntityKill

OxideCarbonEntity

Called when an entity is killed.

object OnEntityKill(BaseNetworkable baseNetworkable)

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

Parameters

baseNetworkable: BaseNetworkable

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 OnEntityKill(BaseNetworkable baseNetworkable)
{
    Puts("OnEntityKill");

    // 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 BaseNetworkable.Kill(BaseNetworkable.DestroyMode, bool)

Passes: BaseNetworkable baseNetworkable

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void Kill(DestroyMode mode = DestroyMode.None, bool callOnKilled = true)
{
	if (IsDestroyed)
	{
		Debug.LogWarning("Calling kill - but already IsDestroyed!? " + this);
		return;
	}
	if (Interface.CallHook("OnEntityKill", this) != null)
	{
		return;
	}
	EntityProfiler.killed++;
	if (EntityProfiler.mode >= 2)
	{
		EntityProfiler.OnKilled(this);
	}
// …

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.