Dimension

分類: クラス

特定のディメンション（例えばネザーなど）を表すクラス

readonly id: string;

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

このプロパティは使用時に例外を投げる場合があります。

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

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

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

getBlock(location: Vector3): Block;

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

• Block

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

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

getEntities(options?: EntityQueryOptions): Entity[]

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

• Entity[]

getEntitiesメソッドはoptionsを指定しない場合、すべてのディメンションのエンティティを取得してしまいます。

例えばオーバーワールドディメンションのgetEntitiesメソッドを使った場合、optionsを指定しないとオーバーワールドのディメンションにも関わらずネザーとジ・エンドのエンティティも取得してしまいます。

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

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

getEntitiesAtBlockLocation(location: Vector3): Entity[];

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

Entity[]

指定した座標に存在するエンティティの配列

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

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

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

getPlayers(options?: EntityQueryOptions): Player[]

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

Player[]

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

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

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

runCommandAsync(commandString: string): Promise<CommandResult>

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

• Promise<CommandResult>