OnFuelCheck

OxideCarbonFuel

Called when fuel check occurs.

object OnFuelCheck(EntityFuelSystem entityFuelSystem)

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

Parameters

entityFuelSystem: EntityFuelSystem

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 OnFuelCheck(EntityFuelSystem entityFuelSystem)
{
    Puts("OnFuelCheck");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool EntityFuelSystem.HasFuel(bool)

Passes: EntityFuelSystem entityFuelSystem

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public bool HasFuel(bool forceCheck = false)
{
	if ((Time.time > nextFuelCheckTime) | forceCheck)
	{
		object returnvar = Interface.CallHook("OnFuelCheck", this);
		if (returnvar is bool)
		{
			return (bool)returnvar;
		}
		cachedHasFuel = (float)GetFuelAmount() > 0f;
		nextFuelCheckTime = Time.time + Random.Range(1f, 2f);
	}
	return cachedHasFuel;
// …

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.