OnPlayerDeath

OxideCarbonPlayer

Called when a player is dead.

object OnPlayerDeath(BasePlayer basePlayer, HitInfo info)

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

Parameters

basePlayer: BasePlayer
info: HitInfo

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 OnPlayerDeath(BasePlayer basePlayer, HitInfo info)
{
    Puts("OnPlayerDeath");

    // 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 BasePlayer.Die(HitInfo)

Passes: BasePlayer basePlayer, HitInfo info

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0)Assembly-CSharp.dll

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

// …
		}
		if (Belt != null && ShouldDropActiveItem())
		{
			Vector3 vector = new Vector3(Random.Range(-2f, 2f), 0.2f, Random.Range(-2f, 2f));
			Belt.DropActive(GetDropPosition(), GetInheritedDropVelocity() + vector.normalized * 3f);
		}
		if (!WoundInsteadOfDying(info))
		{
			if (Interface.CallHook("OnPlayerDeath", this, info) != null)
			{
				return;
			}
			SleepingBag.OnPlayerDeath(this);
			base.Die(info);
		}
	}
}
// …

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.