手册:@minecraft/server.Block

Block

脚本API类

API

脚本API

适用语言

JavaScript

可构造

否

所属模块

@minecraft/server

支持模块版本

≥ 1.1.0

加入版本

?

Block代表维度中某一坐标下的方块。

属性[编辑]

dimension[编辑]

readonly dimension: Dimension;

只读属性，返回方块所在的维度。

返回值: Dimension

isAir[编辑]

readonly isAir: boolean;

只读属性，返回方块是否为空气。

返回值: boolean
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

isLiquid[编辑]

readonly isLiquid: boolean;

只读属性，返回方块是否为液体。

返回值: boolean
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

isSolid[编辑]

readonly isSolid: boolean;

只读属性，返回方块是否为固体方块。

返回值: boolean
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

isWaterlogged[编辑]

isWaterlogged: boolean;

返回或设置方块是否含水。

返回值: boolean

location[编辑]

readonly location: Vector3;

只读属性，返回方块所在维度内的坐标。

返回值: Vector3

permutation[编辑]

readonly permutation: BlockPermutation;

只读属性，包含该方块的置换配置数据。

返回值: BlockPermutation

type[编辑]

readonly type: BlockType;

只读属性，返回该方块的类型。

返回值: BlockType
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

typeId[编辑]

readonly typeId: string;

只读属性，返回该方块的标识符。

返回值: string
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

x[编辑]

readonly x: number;

只读属性，该方块所在维度内的X轴坐标。

返回值: number

y[编辑]

readonly y: number;

只读属性，该方块所在维度内的Y轴坐标。

返回值: number

z[编辑]

readonly z: number;

只读属性，该方块所在维度内的Z轴坐标。

返回值: number

dimension[编辑]

readonly dimension: Dimension;

返回方块所在的维度。

location[编辑]

readonly location: Vector3;

返回方块所在维度内的坐标。

permutation[编辑]

readonly permutation: BlockPermutation;

包含该方块的置换配置数据。

x[编辑]

readonly x: number;

该方块所在维度内的X轴坐标。

y[编辑]

readonly y: number;

该方块所在维度内的Y轴坐标。

z[编辑]

readonly z: number;

该方块所在维度内的Z轴坐标。

方法[编辑]

above[编辑]

above(step): Block | undefined;

返回该方块上方（Y轴正方向）指定位置的方块。

参数

steps?: number（可选）

向上延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

below[编辑]

below(step): Block | undefined;

返回该方块下方（Y轴负方向）指定位置的方块。

参数

steps?: number（可选）

向下延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

bottomCenter[编辑]

bottomCenter(): Vector3;

返回该方块底面中心位置的坐标。

返回值: Vector3

canPlace[编辑]

canPlace(blockToPlace, faceToPlaceOn): boolean;

检查是否可将指定方块（或根据指定方块置换）放在该方块的指定面。

参数

blockToPlace: BlockPermutation | BlockType | string

要检查是否可放置的方块或方块置换。

faceToPlaceOn?: Direction（可选）

要检查的面。默认值为null。

返回值: boolean

center[编辑]

center(): Vector3;

返回该方块中心位置的坐标。

返回值: Vector3

east[编辑]

east(): Block | undefined;

返回该方块东方（X轴正方向）指定位置的方块。

参数

steps?: number（可选）

向东延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

getComponent[编辑]

getComponent(componentId): BlockComponentTypeMap[T] | undefined ;

获取该方块的组件。

参数

componentId: T

方块组件的标识符，若不带命名空间，则默认为minecraft。

返回值: BlockComponentTypeMap[T] | undefined; 若方块存在组件，则返回组件，否则返回undefined。
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

getItemStack[编辑]

getItemStack(amount, withData): ItemStack | undefined;

获取基于该方块的物品堆叠原型。

参数

amount?: number（可选）

物品堆叠中该方块的数量。

withData?: boolean（可选）

是否包含物品堆叠的附加数据。

返回值: ItemStack | undefined; 返回指定堆叠数和相关数据的ItemStack；若方块不兼容，则返回undefined。
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

getRedstonePower[编辑]

getRedstonePower(): number | undefined;

获取该方块的红石信号强度。

返回值: number | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

getTags[编辑]

getTags(): string[];

获取该方块的标签。

返回值: string[]; 返回一组方块标签。
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

hasTag[编辑]

hasTag(tag): boolean;

检查该方块置换是否具有指定的标签。

参数

tag: string

要检查的标签。

返回值: boolean; 若该方块置换具有指定的标签，则返回true，否则返回false。
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

isValid[编辑]

isValid(): boolean;

检测该方块是否有效（在加载区块内）。

返回值: boolean; 如果该方块有效，则返回true，否则返回false。

north[编辑]

north(): Block | undefined;

返回该方块北方（Z轴负方向）指定位置的方块。

参数

steps?: number（可选）

向北延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

offset[编辑]

offset(offset): Block | undefined;

返回相对该方块指定偏移量坐标下的方块。

参数

offset: Vector3

坐标偏移量。

返回值: Block | undefined; 若方块已加载，则返回Block，否则返回undefined。

setPermutation[编辑]

setPermutation(permutation): void;

设置该方块的置换配置数据。

参数

permutation: BlockPermutation

方块的置换配置数据，包含方块的状态。

错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

setType[编辑]

setType(blockType): void;

设置该方块的类型。

参数

blockType: BlockType | string

要设置的方块标识符。

错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

south[编辑]

south(): Block | undefined;

返回该方块南方（Z轴正方向）指定位置的方块。

参数

steps?: number（可选）

向南延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

trySetPermutation[编辑]

trySetPermutation(permutation): boolean;

在允许放置的情况下尝试向当前维度内该方块设置方块置换。

参数

permutation: BlockPermutation

要尝试设置的方块置换。

返回值: boolean; 若方块置换能被成功设置，则返回true，否则返回false。
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

west[编辑]

west(): Block | undefined;

返回该方块西方（X轴正方向）指定位置的方块。

参数

steps?: number（可选）

向西延伸的步长。默认值为1。

返回值: Block | undefined
错误类型: LocationInUnloadedChunkError; LocationOutOfWorldBoundariesError

setPermutation[编辑]

setPermutation(permutation): void;

设置该方块的置换配置数据。

参数: permutation: BlockPermutation; 方块的置换配置数据，包含方块的状态。

历史[编辑]

基岩版
?		加入了`Block`类。
1.17.20	1.17.20.20	加入了`getDimension`方法，用于获取方块所在的维度。
1.19.40	1.19.40.20	将方法`getLocation`用属性`location`替代。
		将方法`getPermutation`和`getBlockData`用属性`permutation`替代。
		将方法`getType`用属性`type`替代。
		将方法`isWaterlogged`和`setWaterlogged`用属性`isWaterlogged`替代。
		将方法`isEmpty`改为了属性。
		移除了`canBeWaterlogged`属性。
	1.19.40.22	将属性`id`重命名为了`typeId`。
1.19.60	1.19.60.22	加入了`getRedstonePower`方法，用于获取红石电路中方块的红石信号强度。
1.19.70	1.19.70.20	加入了`isAir`方法，用于检测方块是否为空气。
		加入了`isLiquid`方法，用于检测方块是否为液体。
		加入了`isSolid`方法，用于检测方块是否为固体方块。
1.19.80	1.19.80.20	将该类移出实验版本并发布于1.1.0。
1.20.10	1.20.10.23	加入了`isValid`方法，用于检测方块是否有效（是否在已加载的区块内）。
1.20.20	1.20.20.22	将`isValid`方法移出实验版本并发布于1.4.0。
1.20.30	1.20.30.21	将方法`isSolid`、`isLiquid`和`isAir`改为了属性。

漏洞[编辑]

关于@minecraft/server.Block的漏洞在国际版中由漏洞追踪器维护，请在此报告漏洞。

匿名

搜索

手册:@minecraft/server.Block

属性[编辑]

dimension[编辑]

isAir[编辑]

isLiquid[编辑]

isSolid[编辑]

isWaterlogged[编辑]

location[编辑]

permutation[编辑]

type[编辑]

typeId[编辑]

x[编辑]

y[编辑]

z[编辑]

dimension[编辑]

location[编辑]

permutation[编辑]

x[编辑]

y[编辑]

z[编辑]

方法[编辑]

above[编辑]

below[编辑]

bottomCenter[编辑]

canPlace[编辑]

center[编辑]

east[编辑]

getComponent[编辑]

getItemStack[编辑]

getRedstonePower[编辑]

getTags[编辑]

hasTag[编辑]

isValid[编辑]

north[编辑]

offset[编辑]

setPermutation[编辑]

setType[编辑]

south[编辑]

trySetPermutation[编辑]

west[编辑]

setPermutation[编辑]

历史[编辑]

漏洞[编辑]

导航

wiki工具

页面工具

其他项目

分类