OnGrowableGather

OxideCarbonResource

Called when a growable gathers.

object OnGrowableGather(GrowableEntity growableEntity, BasePlayer player, bool eat)

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

Parameters

growableEntity: GrowableEntity
player: BasePlayer
eat: bool

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 OnGrowableGather(GrowableEntity growableEntity, BasePlayer player, bool eat)
{
    Puts("OnGrowableGather");

    // 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.PickFruit(BasePlayer, bool)

Passes: GrowableEntity growableEntity, BasePlayer player, bool eat

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public void PickFruit(BasePlayer player, bool eat = false)
{
	if (!CanPick(player))
	{
		return;
	}
	if (Interface.CallHook("OnGrowableGather", this, player, eat) != null)
	{
		return;
	}
	harvests++;
	GiveFruit(player, CurrentPickAmount, eat);
	RandomItemDispenser randomItemDispenser = PrefabAttribute.server.Find<RandomItemDispenser>(prefabID);
	if (randomItemDispenser != null)
	{
// …

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.