Difference between revisions of "Commands.getBlockInfo"

From ComputerCraft Wiki
Jump to: navigation, search
m (See also)
(Clarified state)
Line 16: Line 16:
 
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).
+
The "state" sub-table is only present in Minecraft 1.8+, and contains the [http://minecraft.gamepedia.com/Block_states block state] info for 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: [[commands.getBlockInfos]](), [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki]
 
See also: [[commands.getBlockInfos]](), [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki]
Line 30: Line 30:
 
{{Example
 
{{Example
 
|desc=Prints the facing of the [[Command Computer]] running the script by inspecting its own metadata.
 
|desc=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]]() )'''
local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''
+
 
   
 
   
  [[print]]( "My facing is ", directions[ blockInfo.metadata ], "." )
+
  [[print]]( "My facing is " .. blockInfo.metadata.facing .. "." )
 
}}
 
}}
 
}}
 
}}

Revision as of 23:27, 26 December 2015


Grid Redstone.png  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 the block state info for 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: commands.getBlockInfos(), Data Values @ Minecraft wiki
Syntax commands.getBlockInfo(number x, number y, number z)
Returns table block info
Part of ComputerCraft
API commands

Examples

Grid paper.png  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 )



Grid paper.png  Example
Prints the facing of the Command Computer running the script by inspecting its own metadata.
Code
{{{code}}}


Grid disk.png Commands API Functions
commands.exec - commands.execAsync - commands.list - commands.getBlockPosition - commands.getBlockInfo - commands.getBlockInfos