OnPlanterBoxFertilize

OxideCarbonEntity

Called when planter box fertilize occurs.

object OnPlanterBoxFertilize(PlanterBox planterBox)

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

Parameters

planterBox: PlanterBox

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 OnPlanterBoxFertilize(PlanterBox planterBox)
{
    Puts("OnPlanterBoxFertilize");

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

Passes: PlanterBox planterBox

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public void FertilizeGrowables()
{
	if (Interface.CallHook("OnPlanterBoxFertilize", this) != null)
	{
		return;
	}
	int num = GetFertilizerCount();
	if (num <= 0)
	{
		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.