OnPlayerHealthChange

OxideCarbonPlayer

Called when a player health is changed.

object OnPlayerHealthChange(BasePlayer basePlayer, float oldvalue, float newvalue)

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

Parameters

basePlayer: BasePlayer
oldvalue: float
newvalue: float

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 OnPlayerHealthChange(BasePlayer basePlayer, float oldvalue, float newvalue)
{
    Puts("OnPlayerHealthChange");

    // 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.OnHealthChanged(float, float)

Passes: BasePlayer basePlayer, float oldvalue, float newvalue

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

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

public override void OnHealthChanged(float oldvalue, float newvalue)
{
	if (Interface.CallHook("OnPlayerHealthChange", this, oldvalue, newvalue) != null)
	{
		return;
	}
	base.OnHealthChanged(oldvalue, newvalue);
	if (isServer)
	{
		if (oldvalue > newvalue)
		{
// …

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.