OnDispenserGather

OxideCarbonResource

Called when a dispenser gathers.

object OnDispenserGather(ResourceDispenser resourceDispenser, BasePlayer entity, Item local7)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

resourceDispenser: ResourceDispenser
entity: BasePlayer
local7: Item

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 OnDispenserGather(ResourceDispenser resourceDispenser, BasePlayer entity, Item local7)
{
    Puts("OnDispenserGather");

    // 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 ResourceDispenser.GiveResourceFromItem(BasePlayer, ItemAmount, float, float, AttackEntity)

Passes: ResourceDispenser resourceDispenser, BasePlayer entity, Item local7

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0, l7)Assembly-CSharp.dll

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

// …
}
if (!(f >= 1f))
{
	return;
}
int num5 = CalculateGatherBonus(entity, itemAmt, f);
int iAmount = BaseGameMode.ScaleGatherAmount(Mathf.FloorToInt(f) + num5);
Item item = ItemManager.CreateByItemID(itemAmt.itemid, iAmount, 0uL, 0uL);
if (Interface.CallHook("OnDispenserGather", this, entity, item) != null)
{
	return;
}
if (item != null)
{
	ApplyItemOwnership(entity, item);
	OverrideOwnership(item, attackWeapon);
	Analytics.Azure.OnGatherItem(item.info.shortname, item.amount, baseEntity, entity, attackWeapon);
// …

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.