RustTip

OnFuelItemCheck

OxideCarbonFuel

Called when fuel item check occurs.

object OnFuelItemCheck(EntityFuelSystem entityFuelSystem, StorageContainer local0)
Works — the game method in this build is the one the hook was written for.

Parameters

entityFuelSystem
EntityFuelSystem
local0
StorageContainer

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 OnFuelItemCheck(EntityFuelSystem entityFuelSystem, StorageContainer local0)
{
    Puts("OnFuelItemCheck");

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

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

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

Injection point

Rust.opj (Oxide)
Item EntityFuelSystem.GetFuelItem()

Passes: EntityFuelSystem entityFuelSystem, StorageContainer local0

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

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

public Item GetFuelItem()
{
	StorageContainer fuelContainer = GetFuelContainer();
	object returnvar = Interface.CallHook("OnFuelItemCheck", this, fuelContainer);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	if (fuelContainer == null)
	{
		return null;
	}
// …

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.