Block¶
文档版本：1.21.60.21
Block类。代表维度中的一个方块。一个方块对应了一维度中唯一的X、Y和Z轴坐标值，可读取或修改该坐标下的方块状态等数据。
属性¶
dimension
dimension：Dimension- 返回该方块所在的维度的对象。
isAir
isAir：boolean- 如果该方块为空气，值为
true。
isLiquid
isLiquid：boolean- 如果该方块属于液体方块（含水方块不属于液体方块），值为
true。
isSolid
isSolid：boolean- 如果该方块属于固体方块，值为
true。
isWaterlogged
isWaterlogged：boolean- 表示并接受设置该方块是否含水。如果该方块含水，值为
true。
location
location：Vector3- 该方块的坐标。
permutation
permutation：BlockPermutation- 该方块的置换。
type
type：BlockType- 该方块的类型。
typeId
typeId：string- 该方块的类型对应的标识符。
x
x：int32- 该方块的X轴坐标值。
y
y：int32- 该方块的Y轴坐标值。
z
z：int32- 该方块的Z轴坐标值。
方法¶
above
获取位于该方块上方一定距离处的方块（即Y轴正方向延长线上的方块）。
steps：int32＝1- 向Y轴正方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。
below
获取位于该方块下方一定距离处的方块（即Y轴负方向延长线上的方块）。
steps：int32＝1- 向Y轴负方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。
bottomCenter
获取该方块底面中心处的坐标（即该方块在X和Z轴上的中心坐标）。
- 返回值：
Vector3 - 包含该方块底面中心处坐标值的
Vector3对象。
canPlace
根据类型或置换检查是否可在该方块的某个面上放置给定的方块。
blockToPlace：BlockPermutation|BlockType|string- 要检查放置可行性的方块类型(
BlockType对象)或方块置换(BlockPermutation对象)。
faceToPlaceOn?：Direction＝null- 要检查的面。
- 返回值：
boolean - 如果给定的方块可以放置在该方块的这个面上，返回
true。
center
获取该方块中心处的坐标（即该方块在X、Y和Z轴上的中心坐标）。
- 返回值：
Vector3 - 包含该方块中心处坐标值的
Vector3对象。
east
获取位于该方块东面一定距离处的方块（即X轴正方向延长线上的方块）。
steps：int32＝1- 向X轴正方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。
getComponent
获取一个该方块的组件。
componentId：string- 要获取的组件的标识符。
- 返回值：
BlockComponent|undefined - 如果该方块具有这个组件，返回该组件的对象，否则返回
undefined。
getItemStack
创建一个基于该方块的物品堆叠。
amount：int32＝1∈[1,255]- 该物品堆叠所含物品的数量。
withData：boolean＝False- 该物品堆叠是否附加用户数据。
- 返回值：
ItemStack|undefined - 创建出的物品堆叠对象。如果方块类型不兼容则返回
undefined。
getMapColor
script_api.minecraft/server.block.getmapcolor.description
- 返回值：
RGBA - script_api.minecraft/server.block.getmapcolor.return
getRedstonePower
获取该方块的净红石能量强度。
- 返回值：
int32|undefined - 如果该方块可被充能，返回其红石能量强度，否则返回
undefined。
getTags
获取该方块的所有标签。
- 返回值：
string[] - 一个包含该方块所有标签的数组。
hasTag
检查该方块的置换中是否具有指定的标签。
tag：string- 要检查的标签。
- 返回值：
boolean - 如果该方块的置换中具有此标签，返回
true。
isValid
检查该方块是否有效（被加载且在可放置方块范围内）。
- 返回值：
boolean - 如果该方块有效，返回
true。
matches
测试该方块是否符合给定条件（方块类型和方块状态）。
blockName：string- 要测试的方块类型的标识符。
states?：Record<string, boolean | int32 | string>＝null- 要测试的方块状态集合。
- 返回值：
boolean - 如果该方块符合给定的条件，返回
true。
north
获取位于该方块北面一定距离处的方块（即Z轴负方向延长线上的方块）。
steps：int32＝1- 向Z轴负方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。
offset
获取相对于该方块位置给定偏移量处的方块。
setPermutation
设置该方块的置换。
permutation：BlockPermutation- 要设置的置换的对象。
- 返回值：
void - script_api.minecraft/server.block.setpermutation.return
setType
设置该方块的类型。
blockType：BlockType|string- 要设置的类型的标识符或
BlockType对象。
- 返回值：
void - script_api.minecraft/server.block.settype.return
setWaterlogged
设置该方块的含水情况（仅对可含水方块有效）。
isWaterlogged：boolean- 如果为
true，则使该方块含水，否则取消含水。
- 返回值：
void - script_api.minecraft/server.block.setwaterlogged.return
south
获取位于该方块南面一定距离处的方块（即Z轴正方向延长线上的方块）。
steps：int32＝1- 向Z轴正方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。
trySetPermutation
先检查放置可行性，然后再尝试设置该方块的置换。
permutation：BlockPermutation- 要设置的置换的
BlockPermutation对象。
- 返回值：
boolean - 如果成功设置了该方块的置换，返回
true。
west
获取位于该方块西面一定距离处的方块（即X轴负方向延长线上的方块）。
steps：int32＝1- 向X轴负方向延伸的距离（以米为单位）。
- 返回值：
Block|undefined - 获取到的方块对象。