RustTip

CanCheckFuel

OxideCarbonFuel

Called to determine whether to check fuel.

Return true to allow the action and false to block it.

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

Parameters

entityFuelSystem
EntityFuelSystem
local0
StorageContainer
player
BasePlayer

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

    // 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.IsInFuelInteractionRange(BasePlayer)

Passes: EntityFuelSystem entityFuelSystem, StorageContainer local0, BasePlayer player

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

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

public bool IsInFuelInteractionRange(BasePlayer player)
{
	StorageContainer fuelContainer = GetFuelContainer();
	object returnvar = Interface.CallHook("CanCheckFuel", this, fuelContainer, player);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (fuelContainer != null)
	{
		float num = 0f;
		if (isServer)
// …

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.