Dimension クラス

分類: クラス

バージョン: 1.1.0

特定のディメンション(例えばネザーなど)を表すクラスです。

プロパティ

id

readonly dimension: string

ディメンションの識別子。

メソッド

getBlock

getBlock(location: Vector3): Block

指定した座標のブロックを取得します。

取得できるブロックはディメンション内のものに限られます。

例えば、ネザーディメンションでオーバーワールドのブロックを取得することはできません。

このメソッドは例外を投げることがあります。

パラメータ

  • location: Vector3
    • 取得するブロックの座標

getEntities

getEntities(options?: EntityQueryOptions): Entity[]

条件を指定してエンティティの配列を取得します。

このメソッドは例外を投げることがあります。

パラメータ

  • options?: EntityQueryOptions
    • 取得するエンティティを絞り込むための追加オプション
    • 指定しない場合、すべてのエンティティを取得する

getEntitiesAtBlockLocation

getEntitiesAtBlockLocation(location: Vector3): Entity[]

特定の座標のエンティティを取得します。

取得できるエンティティはディメンション内のエンティティに限られます(例えば、オーバーワールドのディメンションでネザーのエンティティは取得できません)。

パラメータ

  • location: Vector3
    • エンティティを取得する座標

注意点

モブなどのエンティティの場合は正しくエンティティを取得できますが、同一の種類のアイテムエンティティはその座標に複数存在していても全てを正しく取得できないようです。マイクラ側の仕様なのかもしれません。 

getPlayers

getPlayers(options?: EntityQueryOptions): Player[]

条件を指定してディメンション内に存在するプレイヤーを取得します。

条件を指定しない場合はディメンション内のすべてのプレイヤーを取得します。

このメソッドは例外を投げることがあります。

パラメータ

  • options?: EntityQueryOptions
    • 取得するプレイヤーを絞り込むための追加オプション
    • 指定しない場合、すべてのプレイヤーを取得する

runCommandAsync

runCommandAsync(commandString: string): Promise<CommandResult>

ディメンションが実行の主体となって特定のコマンドを非同期に実行します。

非同期に実行できるコマンドは1ティックあたり最大128コマンドです。

このメソッドは例外を投げることがあります。

パラメータ

  • commandString: string
    • 実行するコマンド。
    • コマンドはスラッシュから始めてはいけません(エラーになります)。