OnPlayerRecover

OxideCarbonPlayer

Called when player recover occurs.

object OnPlayerRecover(BasePlayer basePlayer)

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

Parameters

basePlayer: BasePlayer

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 OnPlayerRecover(BasePlayer basePlayer)
{
    Puts("OnPlayerRecover");

    // 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.RecoverFromWounded()

Passes: BasePlayer basePlayer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

private void RecoverFromWounded()
{
	if (Interface.CallHook("OnPlayerRecover", this) != null)
	{
		return;
	}
	if (IsCrawling())
	{
		health = Random.Range(2f, 6f) + healingWhileCrawling;
	}
	healingWhileCrawling = 0f;
// …

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.