OnDecayDamage

OxideCarbonEntity

Called when a decay is damaged.

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

    // 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)

// …
				if (decayPoint.IsOccupied(this))
				{
					num3 -= decayPoint.protection;
				}
			}
		}
		if (num3 > 0f)
		{
			if (Interface.CallHook("OnDecayDamage", this) != null)
			{
				return;
			}
			float num4 = num / GetEntityDecayDuration() * MaxHealth();
			Hurt(num4 * num3 * decayVariance, DamageType.Decay);
		}
	}
}

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.