ACE3/docs/wiki/framework/refuel-framework.md

layout	title	description	group	order	parent	mod	version
wiki	Refuel Framework	Explains how to set-up refueling of objects with the ACE3 refuel system.	framework	5	wiki	ace	major minor patch 3 4 0

1. Config Values

{% raw %}

class CfgVehicles {
    class MyFuelTruck {
        ace_refuel_fuelCargo = 3000; // Maximum fuel cargo amount (in liters)
        ace_refuel_hooks[] = {{0.38,-3.17,-.7},{-0.41,-3.17,-.7}}; // Nozzle hooks positions
    };
    class MyCar {
        ace_refuel_fuelCapacity = 100; // Fuel tank volume (in liters)
    };
    class MyElectricCar {
        ace_refuel_canReceive = 0; // For vehicles which can't be refueled
    };
};

{% endraw %}

Note:

ace_refuel_fuelCapacity is only needed if you aren't inheriting from any of BI base classes or if your vehicle has a different fuel tank size.

2. Functions

2.1 Make an object into a refuel source

Added in ACE3 3.11.0

Meant to be called on server only.

ace_refuel_fnc_makeSource

	Arguments	Type	Optional (default value)
0	Fuel Source	Object	Required
1	Amount (in liters)	Number	Optional (default: 0)
2	Hooks positions	Array	Optional (default: [[0,0,0]])
R	None	None	Return value

2.1.1 Example

[cursorObject, 100] call ace_refuel_fnc_makeSource

	Arguments	Explanation
0	cursorObject	Fuel source object
1	100	Fuel amount (in liters)

2.2 Getting the fuel supply

ace_refuel_fnc_getFuel

	Arguments	Type	Optional (default value)
0	Fuel Truck	Object	Required
R	Fuel amount left (in liters)	Number	Return value

2.2.1 Example

[fuelTruck] call ace_refuel_fnc_getFuel;

	Arguments	Explanation
0	fuelTruck	My fuel truck object

2.3 Setting the fuel supply

ace_refuel_fnc_setFuel

	Arguments	Type	Optional (default value)
0	Fuel Truck	Object	Required
1	Amount (in liters)	Number	Required
R	None	None	Return value

2.3.1 Example

[fuelTruck, 428] call ace_refuel_fnc_setFuel;

	Arguments	Explanation
0	fuelTruck	Fuel truck object
1	428	New fuel amount (in liters)

2.4 Make a jerry can

Meant to be run on all clients and server.

ace_refuel_fnc_makeJerryCan

	Arguments	Type	Optional (default value)
0	Jerry Can	Object	Required
1	Amount (in liters)	Number	Optional (default: 20)
R	None	None	Return value

2.4.1 Example 1

[can] call ace_refuel_fnc_makeJerryCan;

	Arguments	Explanation
0	can	Jerry can object

The jerry can will have the default 20 liters volume.

2.4.2 Example 2

[can, 200] call ace_refuel_fnc_makeJerryCan;

	Arguments	Explanation
0	can	Jerry can object
1	200	Amount (in liters)

The jerry can will now have a volume of 200 liters.

3. Events

Name	Arguments	Global?	Added in
ace_refuel_sourceInitialized	Fuel source (OBJECT)	Yes	3.16.0
ace_refuel_jerryCanInitalized	Jerry can (OBJECT)	Yes	3.16.0