OnCoalingTowerGather

OxideCarbonResource

Called when a coaling tower gathers.

object OnCoalingTowerGather(CoalingTower coalingTower, Item item)

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

Parameters

coalingTower: CoalingTower
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 OnCoalingTowerGather(CoalingTower coalingTower, Item item)
{
    Puts("OnCoalingTowerGather");

    // 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 CoalingTower.EmptyTenPercent()

Passes: CoalingTower coalingTower, Item item

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
{
	foreach (Item item in obj)
	{
		if (tcUnloadingNow.wagonType == TrainCarUnloadable.WagonType.Lootboxes)
		{
			item.Remove();
			continue;
		}
		if (Interface.CallHook("OnCoalingTowerGather", this, item) != null)
		{
			return;
		}
		bool flag3 = item.MoveToContainer(newcontainer);
		if (!flag2 || flag3)
		{
			continue;
		}
// …

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.