OnGrowableStateChange

OxideCarbonResource

Called when a growable state is changed.

object OnGrowableStateChange(GrowableEntity growableEntity, PlantProperties.State state)

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

Parameters

growableEntity: GrowableEntity
state: PlantProperties.State

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 OnGrowableStateChange(GrowableEntity growableEntity, PlantProperties.State state)
{
    Puts("OnGrowableStateChange");

    // 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 GrowableEntity.ChangeState(PlantProperties.State, bool, bool)

Passes: GrowableEntity growableEntity, PlantProperties.State state

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0)Assembly-CSharp.dll

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

public void ChangeState(PlantProperties.State state, bool resetAge, bool loading = false)
{
	if (Interface.CallHook("OnGrowableStateChange", this, state) != null)
	{
		return;
	}
	if (isServer && State == state)
	{
		return;
	}
	State = state;
// …

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.