OnWaterPurify

OxideCarbonEntity

Called when water purify occurs.

object OnWaterPurify(WaterPurifier waterPurifier, float timeCooked)

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

Parameters

waterPurifier: WaterPurifier
timeCooked: 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 OnWaterPurify(WaterPurifier waterPurifier, float timeCooked)
{
    Puts("OnWaterPurify");

    // 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 WaterPurifier.ConvertWater(float)

Passes: WaterPurifier waterPurifier, float timeCooked

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: AllAssembly-CSharp.dll

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

protected void ConvertWater(float timeCooked)
{
	Item slot = purifiedWaterStorage.inventory.GetSlot(0);
	if (stopWhenOutputFull && slot != null && slot.amount >= slot.MaxStackable())
	{
		return;
	}
	if (Interface.CallHook("OnWaterPurify", this, timeCooked) != null)
	{
		return;
	}
	float num = timeCooked * ((float)waterToProcessPerMinute / 60f);
	if (slot != null)
	{
		float num2 = Mathf.Max(slot.MaxStackable() - slot.amount, 0);
		num = Mathf.Min(num, num2 * (float)freshWaterRatio);
// …

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.