OnRunPlayerMetabolism

OxideCarbonPlayer

Called when run player metabolism occurs.

object OnRunPlayerMetabolism(PlayerMetabolism playerMetabolism, BaseCombatEntity ownerEntity, float delta)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

playerMetabolism: PlayerMetabolism
ownerEntity: BaseCombatEntity
delta: 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 OnRunPlayerMetabolism(PlayerMetabolism playerMetabolism, BaseCombatEntity ownerEntity, float delta)
{
    Puts("OnRunPlayerMetabolism");

    // 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 PlayerMetabolism.RunMetabolism(BaseCombatEntity, float)

Passes: PlayerMetabolism playerMetabolism, BaseCombatEntity ownerEntity, float delta

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

protected override void RunMetabolism(BaseCombatEntity ownerEntity, float delta)
{
	if (Interface.CallHook("OnRunPlayerMetabolism", this, ownerEntity, delta) != null)
	{
		return;
	}
	RefreshCalorieCapacity();
	if (owner.IsConnected)
	{
		BaseGameMode activeGameMode = BaseGameMode.GetActiveGameMode(serverside: true);
		float num = owner.currentTemperature;
// …

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.