Difference between revisions of "Commands.getBlockInfo"
From ComputerCraft Wiki
Smiley43210 (Talk | contribs) m (Changed "MineCraft" to "Minecraft") |
Bomb Bloke (Talk | contribs) (CC 1.76 adds the "state" table to the results) |
||
| Line 9: | Line 9: | ||
{ | { | ||
| + | state = {{type|table}} state information | ||
name = {{type|string}} block's name, | name = {{type|string}} block's name, | ||
metadata = {{type|number}} block's metadata | metadata = {{type|number}} block's metadata | ||
| Line 14: | Line 15: | ||
The block inspected will be in the same dimension as the computer. This function yields until the data is available to be returned. If the queried block exists in an ungenerated chunk, this function will cause that chunk to be generated. | The block inspected will be in the same dimension as the computer. This function yields until the data is available to be returned. If the queried block exists in an ungenerated chunk, this function will cause that chunk to be generated. | ||
| + | |||
| + | The "state" sub-table is only present in Minecraft 1.8+, and contains keys relevant to the block being observed. 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). | ||
See also: [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki] | See also: [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki] | ||
Revision as of 01:18, 26 December 2015
 Function commands.getBlockInfo | |
Available only to Command Computers, returns a table containing information on the block at the specified world co-ordinate, formatted as follows:
{
state = table state information
name = string block's name,
metadata = number block's metadata
}
The block inspected will be in the same dimension as the computer. This function yields until the data is available to be returned. If the queried block exists in an ungenerated chunk, this function will cause that chunk to be generated. The "state" sub-table is only present in Minecraft 1.8+, and contains keys relevant to the block being observed. 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). See also: Data Values @ Minecraft wiki | |
| Syntax | commands.getBlockInfo(number x, number y, number z) |
| Returns | table block info |
| Part of | ComputerCraft |
| API | commands |
Examples
 Example | |
| Prints the Command Computer's internal name and metadata value. | |
| Code |
local blockInfo = commands.getBlockInfo( commands.getBlockPosition() ) print( "Computer block's name: ", blockInfo.name ) print( "Computer block's metadata: ", blockInfo.metadata ) |
| Example | |
| Prints the facing of the Command Computer running the script by inspecting its own metadata. | |
| Code |
local directions = {"unknown", "north", "south", "west", "east"}
local blockInfo = commands.getBlockInfo( commands.getBlockPosition() )
print( "My facing is ", directions[ blockInfo.metadata ], "." )
|
 Commands API Functions
|
|---|
| commands.exec - commands.execAsync - commands.list - commands.getBlockPosition - commands.getBlockInfo - commands.getBlockInfos |
