Module:FuelBurnTime/doc

Documentation

[purge]

Note: Template:FuelBurnTime offers a more convenient way to use this module.

Returns a list of item burn time (and fuel/min) for every possible equipment/vehicle/building that uses specified item as a fuel.

Uses Template:Duration and fuel_consumers cargo table.

Usage

{{#invoke:FuelBurnTime|getBurnTime| name=Fuel Name| energy=Energy Value| stack=Stack Size (optional)}}

or without parameter names:

{{#invoke:FuelBurnTime|getBurnTime|Fuel Name|Energy Value|Stack Size (optional)}}

Provide stack size only if you want burn time of a stack, if you want burn time for a single item then omit the third parameter.

Examples

{{#invoke:FuelBurnTime|getStackBurnTime|Solid Biofuel|450}}

{{#invoke:FuelBurnTime|getStackBurnTime|Coal|180|100}}

This is the documentation page, it should be transcluded into the main module page. See Template:Doc for more information.