Block (Bukkit 1.13.2-R0.1-SNAPSHOT API 中文文档)

所有超级接口:

Metadatable
```
public interface Block
extends Metadatable
```
代表方块. This is a live object, and only one Block may exist for any given location in a world. The state of the block may change concurrently to your own handling of it; use block.getState() to get a snapshot state of a block which will not be modified.
Note that parts of this class which require access to the world at large (i.e. lighting and power) may not be able to be safely accessed during world generation when used in cases like BlockPhysicsEvent!!!!

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`boolean`	`breakNaturally()` Breaks the block and spawns items as if a player had digged it
`boolean`	`breakNaturally(ItemStack tool)` Breaks the block and spawns items as if a player had digged it with a specific tool
`Biome`	`getBiome()` Returns the biome that this block resides in
`BlockData`	`getBlockData()` Gets the complete block data for this block
`int`	`getBlockPower()` Returns the redstone power being provided to this block
`int`	`getBlockPower(BlockFace face)` Returns the redstone power being provided to this block face
`BoundingBox`	`getBoundingBox()` Gets the approximate bounding box for this block.
`Chunk`	`getChunk()` 获取包含此方块的区块(方块所在的区块).
`byte`	`getData()` 已过时。不安全的参数
`java.util.Collection<ItemStack>`	`getDrops()` Returns a list of items which would drop by destroying this block
`java.util.Collection<ItemStack>`	`getDrops(ItemStack tool)` Returns a list of items which would drop by destroying this block with a specific tool
`BlockFace`	`getFace(Block block)` Gets the face relation of this block compared to the given block.
`double`	`getHumidity()` Gets the humidity of the biome of this block
`byte`	`getLightFromBlocks()` Get the amount of light at this block from nearby blocks.
`byte`	`getLightFromSky()` Get the amount of light at this block from the sky.
`byte`	`getLightLevel()` 获取此方块的光亮等级，范围0~15.
`Location`	`getLocation()` 获取方块的位置信息.
`Location`	`getLocation(Location loc)` Stores the location of the block in the provided Location object.
`PistonMoveReaction`	`getPistonMoveReaction()` Returns the reaction of the block when moved by a piston
`Block`	`getRelative(BlockFace face)` Gets the block at the given face This method is equal to getRelative(face, 1)
`Block`	`getRelative(BlockFace face, int distance)` Gets the block at the given distance of the given face For example, the following method places water at 100,102,100; two blocks above 100,100,100.
`Block`	`getRelative(int modX, int modY, int modZ)` 以指定坐标偏移量获取方块（相对与方块位置的偏移量）.
`BlockState`	`getState()` Captures the current state of this block.
`double`	`getTemperature()` Gets the temperature of this block.
`Material`	`getType()` 获取此方块的种类.
`World`	`getWorld()` 获取此方块所处的世界.
`int`	`getX()` 获取此方块的X坐标.
`int`	`getY()` 获取此方块的Y坐标.
`int`	`getZ()` 获取此方块的Z坐标.
`boolean`	`isBlockFaceIndirectlyPowered(BlockFace face)` Returns true if the block face is being indirectly powered by Redstone.
`boolean`	`isBlockFacePowered(BlockFace face)` Returns true if the block face is being powered by Redstone.
`boolean`	`isBlockIndirectlyPowered()` Returns true if the block is being indirectly powered by Redstone.
`boolean`	`isBlockPowered()` Returns true if the block is being powered by Redstone.
`boolean`	`isEmpty()` Checks if this block is empty.
`boolean`	`isLiquid()` Checks if this block is liquid.
`boolean`	`isPassable()` Checks if this block is passable.
`RayTraceResult`	`rayTrace(Location start, Vector direction, double maxDistance, FluidCollisionMode fluidCollisionMode)` Performs a ray trace that checks for collision with this specific block in its current state using its precise collision shape.
`void`	`setBiome(Biome bio)` Sets the biome that this block resides in
`void`	`setBlockData(BlockData data)` Sets the complete data for this block
`void`	`setBlockData(BlockData data, boolean applyPhysics)` Sets the complete data for this block
`void`	`setType(Material type)` 设置这个方块的类型.
`void`	`setType(Material type, boolean applyPhysics)` Sets the type of this block

从接口继承的方法 org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata

- 方法详细资料
  - getData
```
@Deprecated
byte getData()
```
    已过时。不安全的参数
    
    获取此方块的元数据.
    原文:Gets the metadata for this block
    
    返回:
    
    方块元数据
  - getBlockData
```
BlockData getBlockData()
```
    Gets the complete block data for this block
    
    返回:
    
    block specific data
  - getRelative
```
Block getRelative(int modX,
                  int modY,
                  int modZ)
```
    以指定坐标偏移量获取方块（相对与方块位置的偏移量）.
    原文：Gets the block at the given offsets
    
    参数:
    
    modX - X坐标偏移量
    
    modY - Y坐标偏移量
    
    modZ - Z坐标偏移量
    
    返回:
    
    在此坐标偏移量的方块
  - getRelative
```
Block getRelative(BlockFace face)
```
    Gets the block at the given face
    This method is equal to getRelative(face, 1)
    
    参数:
    
    face - Face of this block to return
    
    返回:
    
    Block at the given face
    
    另请参阅:
    
    getRelative(BlockFace, int)
  - getRelative
```
Block getRelative(BlockFace face,
                  int distance)
```
    Gets the block at the given distance of the given face
    For example, the following method places water at 100,102,100; two blocks above 100,100,100.
```
 Block block = world.getBlockAt(100, 100, 100);
 Block shower = block.getRelative(BlockFace.UP, 2);
 shower.setType(Material.WATER);
 
```
    参数:
    
    face - Face of this block to return
    
    distance - Distance to get the block at
    
    返回:
    
    Block at the given face
  - getType
```
Material getType()
```
    获取此方块的种类.
    原文:Gets the type of this block
    
    返回:
    
    方块种类
  - getLightLevel
```
byte getLightLevel()
```
    获取此方块的光亮等级，范围0~15.
    原文：Gets the light level between 0-15
    
    返回:
    
    光亮等级
  - getLightFromSky
```
byte getLightFromSky()
```
    Get the amount of light at this block from the sky.
    Any light given from other sources (such as blocks like torches) will be ignored.
    
    返回:
    
    Sky light level
  - getLightFromBlocks
```
byte getLightFromBlocks()
```
    Get the amount of light at this block from nearby blocks.
    Any light given from other sources (such as the sun) will be ignored.
    
    返回:
    
    Block light level
  - getWorld
```
World getWorld()
```
    获取此方块所处的世界.
    原文：Gets the world which contains this Block
    
    返回:
    
    方块所处的世界
  - getX
```
int getX()
```
    获取此方块的X坐标.
    原文：Gets the x-coordinate of this block
    
    返回:
    
    X坐标
  - getY
```
int getY()
```
    获取此方块的Y坐标.
    原文：Gets the y-coordinate of this block
    
    返回:
    
    Y坐标
  - getZ
```
int getZ()
```
    获取此方块的Z坐标.
    原文：Gets the z-coordinate of this block
    
    返回:
    
    Z坐标
  - getLocation
```
Location getLocation()
```
    获取方块的位置信息.
    原文:Gets the Location of the block
    
    返回:
    
    方块的位置
  - getLocation
```
Location getLocation(Location loc)
```
    Stores the location of the block in the provided Location object.
    If the provided Location is null this method does nothing and returns null.
    
    参数:
    
    loc - the location to copy into
    
    返回:
    
    The Location object provided or null
  - getChunk
```
Chunk getChunk()
```
    获取包含此方块的区块(方块所在的区块).
    原文:Gets the chunk which contains this block
    
    返回:
    
    包含此方块的区块
  - setBlockData
```
void setBlockData(BlockData data)
```
    Sets the complete data for this block
    
    参数:
    
    data - new block specific data
  - setBlockData
```
void setBlockData(BlockData data,
                  boolean applyPhysics)
```
    Sets the complete data for this block
    
    参数:
    
    data - new block specific data
    
    applyPhysics - false to cancel physics from the changed block
  - setType
```
void setType(Material type)
```
    设置这个方块的类型.
    原文:Sets the type of this block
    
    参数:
    
    type - 方块的Material类型
  - setType
```
void setType(Material type,
             boolean applyPhysics)
```
    Sets the type of this block
    
    参数:
    
    type - Material to change this block to
    
    applyPhysics - False to cancel physics on the changed block.
  - getFace
```
BlockFace getFace(Block block)
```
    Gets the face relation of this block compared to the given block.
    For example:
```
 Block current = world.getBlockAt(100, 100, 100);
 Block target = world.getBlockAt(100, 101, 100);

 current.getFace(target) == BlockFace.Up;
 
```
    If the given block is not connected to this block, null may be returned
    参数:
    
    block - Block to compare against this block
    
    返回:
    
    BlockFace of this block which has the requested block, or null
  - getState
```
BlockState getState()
```
    Captures the current state of this block. You may then cast that state into any accepted type, such as Furnace or Sign.
    The returned object will never be updated, and you are not guaranteed that (for example) a sign is still a sign after you capture its state.
    
    返回:
    
    BlockState with the current state of this block.
  - getBiome
```
Biome getBiome()
```
    Returns the biome that this block resides in
    
    返回:
    
    Biome type containing this block
  - setBiome
```
void setBiome(Biome bio)
```
    Sets the biome that this block resides in
    
    参数:
    
    bio - new Biome type for this block
  - isBlockPowered
```
boolean isBlockPowered()
```
    Returns true if the block is being powered by Redstone.
    
    返回:
    
    True if the block is powered.
  - isBlockIndirectlyPowered
```
boolean isBlockIndirectlyPowered()
```
    Returns true if the block is being indirectly powered by Redstone.
    
    返回:
    
    True if the block is indirectly powered.
  - isBlockFacePowered
```
boolean isBlockFacePowered(BlockFace face)
```
    Returns true if the block face is being powered by Redstone.
    
    参数:
    
    face - The block face
    
    返回:
    
    True if the block face is powered.
  - isBlockFaceIndirectlyPowered
```
boolean isBlockFaceIndirectlyPowered(BlockFace face)
```
    Returns true if the block face is being indirectly powered by Redstone.
    
    参数:
    
    face - The block face
    
    返回:
    
    True if the block face is indirectly powered.
  - getBlockPower
```
int getBlockPower(BlockFace face)
```
    Returns the redstone power being provided to this block face
    
    参数:
    
    face - the face of the block to query or BlockFace.SELF for the block itself
    
    返回:
    
    The power level.
  - getBlockPower
```
int getBlockPower()
```
    Returns the redstone power being provided to this block
    
    返回:
    
    The power level.
  - isEmpty
```
boolean isEmpty()
```
    Checks if this block is empty.
    A block is considered empty when getType() returns Material.AIR.
    
    返回:
    
    true if this block is empty
  - isLiquid
```
boolean isLiquid()
```
    Checks if this block is liquid.
    A block is considered liquid when getType() returns Material.WATER or Material.LAVA.
    
    返回:
    
    true if this block is liquid
  - getTemperature
```
double getTemperature()
```
    Gets the temperature of this block.
    If the raw biome temperature without adjusting for height effects is required then please use World.getTemperature(int, int).
    
    返回:
    
    Temperature of this block
  - getHumidity
```
double getHumidity()
```
    Gets the humidity of the biome of this block
    
    返回:
    
    Humidity of this block
  - getPistonMoveReaction
```
PistonMoveReaction getPistonMoveReaction()
```
    Returns the reaction of the block when moved by a piston
    
    返回:
    
    reaction
  - breakNaturally
```
boolean breakNaturally()
```
    Breaks the block and spawns items as if a player had digged it
    
    返回:
    
    true if the block was destroyed
  - breakNaturally
```
boolean breakNaturally(ItemStack tool)
```
    Breaks the block and spawns items as if a player had digged it with a specific tool
    
    参数:
    
    tool - The tool or item in hand used for digging
    
    返回:
    
    true if the block was destroyed
  - getDrops
```
java.util.Collection<ItemStack> getDrops()
```
    Returns a list of items which would drop by destroying this block
    
    返回:
    
    a list of dropped items for this type of block
  - getDrops
```
java.util.Collection<ItemStack> getDrops(ItemStack tool)
```
    Returns a list of items which would drop by destroying this block with a specific tool
    
    参数:
    
    tool - The tool or item in hand used for digging
    
    返回:
    
    a list of dropped items for this type of block
  - isPassable
```
boolean isPassable()
```
    Checks if this block is passable.
    A block is passable if it has no colliding parts that would prevent players from moving through it.
    Examples: Tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
    
    返回:
    
    true if passable
  - rayTrace
```
RayTraceResult rayTrace(Location start,
                        Vector direction,
                        double maxDistance,
                        FluidCollisionMode fluidCollisionMode)
```
    Performs a ray trace that checks for collision with this specific block in its current state using its precise collision shape.
    
    参数:
    
    start - the start location
    
    direction - the ray direction
    
    maxDistance - the maximum distance
    
    fluidCollisionMode - the fluid collision mode
    
    返回:
    
    the ray trace hit result, or null if there is no hit
  - getBoundingBox
```
BoundingBox getBoundingBox()
```
    Gets the approximate bounding box for this block.
    This isn't exact as some blocks Stairs contain many bounding boxes to establish their complete form. Also, the box may not be exactly the same as the collision shape (such as cactus, which is 16/16 of a block with 15/16 collisional bounds). This method will return an empty bounding box if the geometric shape of the block is empty (such as air blocks).
    
    返回:
    
    the approximate bounding box of the block

接口 Block

方法概要

从接口继承的方法 org.bukkit.metadata.Metadatable

方法详细资料

getData

getBlockData

getRelative

getRelative

getRelative

getType

getLightLevel

getLightFromSky

getLightFromBlocks

getWorld

getX

getY

getZ

getLocation

getLocation

getChunk

setBlockData

setBlockData

setType

setType

getFace

getState

getBiome

setBiome

isBlockPowered

isBlockIndirectlyPowered

isBlockFacePowered

isBlockFaceIndirectlyPowered

getBlockPower

getBlockPower

isEmpty

isLiquid

getTemperature

getHumidity

getPistonMoveReaction

breakNaturally

breakNaturally

getDrops

getDrops

isPassable

rayTrace

getBoundingBox