OnDecayHeal

OxideCarbonEntity

Called when a decay is healed.

object OnDecayHeal(DecayEntity decayEntity)

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

Parameters

decayEntity: DecayEntity

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 OnDecayHeal(DecayEntity decayEntity)
{
    Puts("OnDecayHeal");

    // 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 DecayEntity.OnDecay(Decay, float)

Passes: DecayEntity decayEntity

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

// …
	{
		upkeepTimer -= buildingPrivilege.PurchaseUpkeepTime(this, Mathf.Max(upkeepTimer, 600f));
	}
}
if (upkeepTimer < 1f)
{
	if (healthFraction < 1f && GetEntityHealScale() > 0f && SecondsSinceAttacked > 600f)
	{
		if (Interface.CallHook("OnDecayHeal", this) != null)
		{
			return;
		}
		float num2 = decayDeltaTime / GetEntityDecayDuration() * GetEntityHealScale();
		Heal(MaxHealth() * num2);
	}
	return;
}
// …

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.