Difference between revisions of "Turtle.inspect"

Revision as of 02:02, 26 December 2015

Function turtle.inspect
Returns the ID string and metadata of the block in front of the Turtle in a table format: `{ name = "modname:blockname", metadata = 0, state = {} }`. The "state" sub-table is only present in Minecraft 1.8+, and contains keys relevant to the block being inspected. For example, a log of wood's state table contains the keys "variant" (which may be set to eg "oak"), and "axis" (which may be set to eg "y", indicating an upright orientation).
Syntax	turtle.inspect()
Returns	boolean success, table data/string error message
Part of	ComputerCraft
API	turtle

Example
If there is a block in front of the turtle, prints it's name and metadata.
Code	local success, data = turtle.inspect() if success then print("Block name: ", data.name) print("Block metadata: ", data.metadata) end

@@ Line 6: / Line 6: @@
 |returns={{type|boolean}} success, {{type|table}} data/{{type|string}} error message
 |addon=ComputerCraft
-|desc=Returns the ID string and metadata of the block in front of the Turtle in a table format: <var>{ name = "modname:blockname", metadata = 0 }</var>.
+|desc=Returns the ID string and metadata of the block in front of the Turtle in a table format: <var>{ name = "modname:blockname", metadata = 0, state = {} }</var>.<br><br>
+The "state" sub-table is only present in Minecraft 1.8+, and contains keys relevant to the block being inspected. For example, a log of wood's state table contains the keys "variant" (which may be set to eg "oak"), and "axis" (which may be set to eg "y", indicating an upright orientation).
 |examples={{Example
 |desc=If there is a block in front of the turtle, prints it's name and metadata.