RustTip

OnQuarryGather

OxideCarbonResource

Called when a quarry gathers.

object OnQuarryGather(MiningQuarry miningQuarry, Item item)
Works — the game method in this build is the one the hook was written for.

Parameters

miningQuarry
MiningQuarry
item
Item

Return value

objectReturn non-null to stop the game method.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnQuarryGather(MiningQuarry miningQuarry, Item item)
{
    Puts("OnQuarryGather");

    // 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 MiningQuarry.ProcessResources()

Passes: MiningQuarry miningQuarry, Item item

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
{
	int num4 = num3 - num2;
	if (BaseGameMode.GetActiveGameMode(serverside: true) is GameModeSoftcore)
	{
		num4 = Mathf.Max(1, Mathf.RoundToInt((float)num4 * GameModeSoftcore.gather_rate));
	}
	Item item = ItemManager.Create(resource.type, num4, 0uL, isServerSide: true, 0uL);
	Analytics.Azure.OnQuarryItem(Analytics.Azure.ResourceMode.Produced, item.info.shortname, item.amount, this);
	if (Interface.CallHook("OnQuarryGather", this, item) != null)
	{
		return;
	}
	if (!item.MoveToContainer(hopperPrefab.instance.GetComponent<StorageContainer>().inventory))
	{
		item.Remove();
		SetOn(isOn: false);
	}
// …

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.