OnFuelAmountCheck

OxideCarbonFuel

Called when fuel amount check occurs.

object OnFuelAmountCheck(EntityFuelSystem entityFuelSystem, Item local0)

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

Parameters

entityFuelSystem: EntityFuelSystem
local0: Item

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnFuelAmountCheck(EntityFuelSystem entityFuelSystem, Item local0)
{
    Puts("OnFuelAmountCheck");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return default(int); // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

int EntityFuelSystem.GetFuelAmount()

Passes: EntityFuelSystem entityFuelSystem, Item local0

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, l0)Assembly-CSharp.dll

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

public int GetFuelAmount()
{
	Item fuelItem = GetFuelItem();
	object returnvar = Interface.CallHook("OnFuelAmountCheck", this, fuelItem);
	if (returnvar is int)
	{
		return (int)returnvar;
	}
	if (fuelItem == null || fuelItem.amount < 1)
	{
		return 0;
	}
// …

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.