EntityQueryOptions インターフェイス

分類: インターフェイス

バージョン: 1.1.0

エンティティを取得する際のオプションを含むインターフェイスです。

プロパティ

closest

closest?: number

取得するエンティティの最大数を指定します。エンティティは指定した座標から近い順に取得されます。

例えばclosest: 3とした場合、座標を中心として3つのエンティティを優先して取得します。

このプロパティを利用する場合はlocationプロパティをセットする必要があります。

excludeFamilies

excludeFamilies?: string[]

除外するファミリー(エンティティグループ)を指定します。

excludeGameModes

excludeNames?: string[]

特定のゲームモードを持つエンティティを除外します。

excludeNames

excludeNames?: string[]

特定の名前を持つエンティティを除外します。

excludeTags

excludeTags?: string[]

特定のタグを持つエンティティを除外します。

excludeTypes

excludeTypes?: string[]

特定のタイプID(minecraft:playerなど)をもつエンティティを除外します。

families

families?: string[]

指定したファミリーに該当するエンティティを取得します。

farthest

farthest?: number

取得するエンティティの最大数を指定します。

エンティティは指定した座標から遠い順に取得されます。

例えばclosest: 3とした場合、座標から遠い順に3つのエンティティを優先して取得します。

このプロパティを利用する場合はlocationプロパティをセットする必要があります。

gameMode

gameMode?: GameMode

指定したゲームモードを持つエンティティを取得します。

location

location?: Vector3

エンティティを取得する際の中心座標を設定します。

maxDistance

maxDistance?: number

中心座標からの最大距離を指定します。

指定した最大距離以内に存在するエンティティが取得対象になります。

このプロパティを利用する場合はlocationプロパティをセットする必要があります。

maxHorizontalRotation

maxHorizontalRotation?: number

最大水平角を指定します。

maxLevel

maxLevel?: number

指定した場合、指定したレベル以下のプレイヤーが取得の対象となります。

maxVerticalRotation

maxVerticalRotation?: number

ピッチ角の最大値を指定します。

ピッチ角の範囲は-90(直上)~0(水平方向)~90(直下)。

minDistance

minDistance?: number

中心座標からの最小距離を指定します。指定した最小距離以上に存在するエンティティが取得対象になります。

このプロパティを利用する場合はlocationプロパティをセットする必要があります。

minHorizontalRotation

minHorizontalRotation?: number

最小水平角を指定します。

minLevel

minLevel?: number

指定した場合、指定したレベル以上のプレイヤーが取得の対象となります。

minVerticalRotation

maxVerticalRotation?: number

ピッチ角の最小値を指定します。

ピッチ角の範囲は-90(直上)~0(水平方向)~90(直下)。

name

name?: string

特定の名前を持ったエンティティを含めます。

scoreOptions

scoreOptions?: EntityQueryScoreOptions[]

EntityQueryScoreOptionsをフィルタ条件にします。

tags

tags?: string[]

指定したタグをフィルタ条件にします。

type

type?: string

指定したタイプ(playerなど)をフィルタ条件にします。