Turtle.refuel - Revision history

MisterSanderson: Clarifying the consumption of fuel, and adding a note about loosing fuel.

2015-04-21T14:31:13Z

Clarifying the consumption of fuel, and adding a note about loosing fuel.

2014-09-11T05:29:45Z

‎Fuel Values: Wikilinking lava

2014-03-29T01:42:52Z

2014-03-29T01:37:34Z

1.6 notes.

2013-11-06T19:04:02Z

better code examples

2013-07-18T14:46:59Z

Changing int to number

2013-06-04T14:50:12Z

Added integer tag and prettied up the arg description

2013-04-08T15:45:50Z

2013-04-08T15:44:28Z

Added a command-line example of turtle.refuel since users are clueless about it's existance

2013-02-04T12:03:03Z

@@ Line 6: / Line 6: @@
 |returns={{type|boolean}} true if fueled, else false.
 |addon=ComputerCraft
-|desc=If the currently selected slot contains [[#Fuel_Values|fuel]] items, it will consume them to give the [[turtle]] the ability to move. If the current slot doesn't contain fuel items, it returns false. If a quantity is specified, it will refuel only up to that many items (if 32 is specified and 16 is present only 16 will be consumed), otherwise, it will consume all the items in the slot.<br><br>
+|desc=If the currently selected slot contains [[#Fuel_Values|fuel]] items, it will consume them to give the [[turtle]] the ability to move. If the current slot doesn't contain fuel items, it returns false. If a quantity is specified, it will refuel only up to that many items. If the avaiable items quantity is lower than the specified, only the avaiable quantity will be consumed, because it can't consume what doesn't exist. If no quantity is specified, it will consume all the items in the slot. Turtles loose all the fuel when broken if they don't have a [[label]].<br><br>
 As of ComputerCraft 1.6, turtles may no longer store practically unlimited amounts of fuel. Attempting to refuel past a given turtle's [[Turtle.getFuelLimit|limit]] with this command will destroy the items regardless, but fails to raise the fuel level higher than maximum and returns no error.<br><br>

@@ Line 76: / Line 76: @@
 | Vanilla
 |-
-| Lava
+| [[Lava]]
 | 1000
 | Vanilla
@@ Line 118: / Line 118: @@
 Formula changed to ((fuel * 5) / 100)
 == Trivia ==
 [[Category:Lua_Core_Functions]]

@@ Line 8: / Line 8: @@
 |desc=If the currently selected slot contains [[#Fuel_Values|fuel]] items, it will consume them to give the [[turtle]] the ability to move. If the current slot doesn't contain fuel items, it returns false. If a quantity is specified, it will refuel only up to that many items (if 32 is specified and 16 is present only 16 will be consumed), otherwise, it will consume all the items in the slot.<br><br>
-As of ComputerCraft 1.6, turtles may no longer store practically unlimited amounts of fuel. Attempting to refuel past a given turtle's [[Turtle.getFuelLimit|limit]] with this command will destroy the items, but fails to raise the fuel level higher and returns no error.<br><br>
+As of ComputerCraft 1.6, turtles may no longer store practically unlimited amounts of fuel. Attempting to refuel past a given turtle's [[Turtle.getFuelLimit|limit]] with this command will destroy the items regardless, but fails to raise the fuel level higher than maximum and returns no error.<br><br>
 See also: [[Turtle.getFuelLevel|turtle.getFuelLevel()]], [[Turtle.getFuelLimit|turtle.getFuelLimit()]]

@@ Line 2: / Line 2: @@
 {{Function
 |name=turtle.refuel
-|args={{type|number}} fuel item consume quantity
+|args={{type|number}} fuel item consume quantity (optional)
 |api=turtle
-|returns={{type|boolean}} true if fuel, else false.
+|returns={{type|boolean}} true if fueled, else false.
 |addon=ComputerCraft
-|desc=If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move. If the current slot doesn't contain a fuel item, it returns false. If a quantity is specified, it will refuel only up to that many items (if 32 is specified and 16 is present only 16 will be consumed), otherwise, it will consume all the items in the slot.
+|desc=If the currently selected slot contains [[#Fuel_Values|fuel]] items, it will consume them to give the [[turtle]] the ability to move. If the current slot doesn't contain fuel items, it returns false. If a quantity is specified, it will refuel only up to that many items (if 32 is specified and 16 is present only 16 will be consumed), otherwise, it will consume all the items in the slot.<br><br>
 |examples=
 {{Example
@@ Line 33: / Line 37: @@
 == Fuel Values ==
-Fuel values for different items.
+Fuel values for some different items. Note that other items are accepted (including both vanilla / mod items) - generally, if an item can be used in a furnace it'll provide fuel equal to the number of items it could smelt, multiplied by ten.
 {| class="wikitable sortable"

@@ Line 2: / Line 2: @@
 {{Function
 |name=turtle.refuel
-|args={{type|number}} amount of fuel items in current slot to consume
+|args={{type|number}} fuel item consume quantity
 |api=turtle
 |returns={{type|boolean}} true if fuel, else false.
 |addon=ComputerCraft
-|desc=Fills the turtle with fuel.
+|desc=If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move. If the current slot doesn't contain a fuel item, it returns false. If a quantity is specified, it will refuel only up to that many items (if 32 is specified and 16 is present only 16 will be consumed), otherwise, it will consume all the items in the slot.
 |examples=
 {{Example
-|desc=Fills the turtle with fuel
+|desc=Checks if the item in the current slot can be used as fuel without consuming it
-|code=turtle.refuel( 4 )
+|code=local valid = turtle.refuel(0)
-|output=Tries to refuel with up to 4 items, returns true if it is a fuel and false if not.
+ print(valid)
 }}
 {{Example
-|desc=Used in the command-line, the below code will tell the turtle to fuel itself using all inventory slots (1, 16)
+|desc=Consumes only 4 items in the current slot if the item is a valid fuel
-|code=refuel all
+|code=local success = turtle.refuel(4)
-|output=To complete
+ print(success)
 }}
 }}

@@ Line 76: / Line 76: @@
 |-
 | Coal Coke
-| 160
+| 320
 | Railcraft
 |}