cFurnaceEntity

cFurnaceEntity class

This class represents a furnace block entity in the world.

See also cRoot's GetFurnaceRecipe() and GetFurnaceFuelBurnTime() functions

This class inherits from the following parent classes:

Name	Value	Notes
ContentsHeight	1	Height (Y) of the cItemGrid representing the contents
ContentsWidth	3	Width (X) of the cItemGrid representing the contents

When using the GetSlot() or SetSlot() function, use these constants for slot index:

Name	Parameters	Return value	Notes
GetCookTimeLeft		number	Returns the time until the current item finishes cooking, in ticks
GetFuelBurnTimeLeft		number	Returns the time until the current fuel is depleted, in ticks
GetFuelSlot		cItem	Returns the item in the fuel slot
GetInputSlot		cItem	Returns the item in the input slot
GetOutputSlot		cItem	Returns the item in the output slot
GetTimeCooked		number	Returns the time that the current item has been cooking, in ticks
HasFuelTimeLeft		bool	Returns true if there's time before the current fuel is depleted
SetFuelSlot	cItem		Sets the item in the fuel slot
SetInputSlot	cItem		Sets the item in the input slot
SetOutputSlot	cItem		Sets the item in the output slot

Name	Parameters	Return value	Notes
GetContents		cItemGrid	Returns the cItemGrid object representing the items stored within this block entity
GetSlot	SlotNum	cItem	Returns the cItem for the specified slot number. Returns nil for invalid slot numbers
GetSlot	X, Y	cItem	Returns the cItem for the specified slot coords. Returns nil for invalid slot coords
SetSlot	SlotNum, cItem		Sets the cItem for the specified slot number. Ignored if invalid slot number
SetSlot	X, Y, cItem		Sets the cItem for the specified slot coords. Ignored if invalid slot coords

Name	Return value	Notes
GetBlockType	BLOCKTYPE	Returns the blocktype which is represented by this blockentity. This is the primary means of type-identification
GetChunkX	number	Returns the chunk X-coord of the block entity's chunk
GetChunkZ	number	Returns the chunk Z-coord of the block entity's chunk
GetPos	Vector3i	Returns the name of the parent class, or empty string if no parent class.
GetPosX	number	Returns the block X-coord of the block entity's block
GetPosY	number	Returns the block Y-coord of the block entity's block
GetPosZ	number	Returns the block Z-coord of the block entity's block
GetRelX	number	Returns the relative X coord of the block entity's block within the chunk
GetRelZ	number	Returns the relative Z coord of the block entity's block within the chunk
GetWorld	cWorld	Returns the world to which the block entity belongs