me.desht.sensibletoolbox.api.recipes

Class FuelItems

java.lang.Object

me.desht.sensibletoolbox.api.recipes.FuelItems

public class FuelItems
extends Object

Represents items that may be converted to SCU by some machine. A machine which does this conversion can create a static instance of this object, to effectively use as a fuel dictionary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FuelItems.FuelValues Store information about a particular item's fuel properties.

Constructor Summary

Constructors

Constructor and Description
FuelItems()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFuel(ItemStack stack, boolean ignoreData, double chargePerTick, int burnTime) Register an item as fuel.
FuelItems.FuelValues	get(ItemStack stack) Get the fuel values for the given item.
boolean	has(ItemStack stack) Check if the given can be used as a fuel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FuelItems

public FuelItems()

Method Detail

addFuel

public void addFuel(ItemStack stack,
           boolean ignoreData,
           double chargePerTick,
           int burnTime)

Register an item as fuel.

Parameters:

stack - the item to register

ignoreData - true if the item's data value should be ignore; false otherwise

chargePerTick - the amount of SCU generated per tick

burnTime - the time in server ticks to convert the item into SCU

get

public FuelItems.FuelValues get(ItemStack stack)

Get the fuel values for the given item.

Parameters:

stack - the item to check

Returns:

the fuel values for the item, or null if this item is not known

has

public boolean has(ItemStack stack)

Check if the given can be used as a fuel.

Parameters:

stack - the item to check

Returns:

true if the item is a fuel, false otherwise