RustTip

OnFuelConsume

OxideCarbonFuel

Called when fuel consume occurs.

object OnFuelConsume(BaseOven baseOven, Item fuel, ItemModBurnable burnable)
Works — the game method in this build is the one the hook was written for.

Parameters

baseOven
BaseOven
fuel
Item
burnable
ItemModBurnable

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 OnFuelConsume(BaseOven baseOven, Item fuel, ItemModBurnable burnable)
{
    Puts("OnFuelConsume");

    // 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 BaseOven.ConsumeFuel(Item, ItemModBurnable)

Passes: BaseOven baseOven, Item fuel, ItemModBurnable burnable

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

private void ConsumeFuel(Item fuel, ItemModBurnable burnable)
{
	if (Interface.CallHook("OnFuelConsume", this, fuel, burnable) != null)
	{
		return;
	}
	if (allowByproductCreation && burnable.byproductItem != null && Random.Range(0f, 1f) > burnable.byproductChance)
	{
		int num = burnable.byproductAmount * GetCharcoalRate();
		bool flag = false;
		foreach (Item item2 in inventory.itemList)
// …

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.