手冊:@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工具

頁面工具

其它專案

分類