Interface EntityQueryOptions

Contains options for selecting entities within an area.

interface EntityQueryOptions {
    closest?: number;
    excludeFamilies?: string[];
    excludeGameModes?: GameMode[];
    excludeNames?: string[];
    excludeTags?: string[];
    excludeTypes?: string[];
    families?: string[];
    farthest?: number;
    gameMode?: GameMode;
    location?: Vector3;
    maxDistance?: number;
    maxHorizontalRotation?: number;
    maxLevel?: number;
    maxVerticalRotation?: number;
    minDistance?: number;
    minHorizontalRotation?: number;
    minLevel?: number;
    minVerticalRotation?: number;
    name?: string;
    scoreOptions?: EntityQueryScoreOptions[];
    tags?: string[];
    type?: string;
}

Properties

closest? excludeFamilies? excludeGameModes? excludeNames? excludeTags? excludeTypes? families? farthest? gameMode? location? maxDistance? maxHorizontalRotation? maxLevel? maxVerticalRotation? minDistance? minHorizontalRotation? minLevel? minVerticalRotation? name? scoreOptions? tags? type?

Properties

Optionalclosest

closest?: number

Remarks

Limits the number of entities to return, opting for the closest N entities as specified by this property. The location value must also be specified on the query options object.

OptionalexcludeFamilies

excludeFamilies?: string[]

Remarks

Excludes entities that match one or more of the specified families.

OptionalexcludeGameModes

excludeGameModes?: GameMode[]

Remarks

Excludes entities if have a specific gamemode that matches the specified gamemode.

OptionalexcludeNames

excludeNames?: string[]

Remarks

Excludes entities that have a name that match one of the specified values.

OptionalexcludeTags

excludeTags?: string[]

Remarks

Excludes entities with a tag that matches one of the specified values.

OptionalexcludeTypes

excludeTypes?: string[]

Remarks

Excludes entities if they are one of the specified types.

Optionalfamilies

families?: string[]

Remarks

If specified, includes entities that match all of the specified families.

Optionalfarthest

farthest?: number

Remarks

Limits the number of entities to return, opting for the farthest N entities as specified by this property. The location value must also be specified on the query options object.

OptionalgameMode

gameMode?: GameMode

Remarks

If specified, includes entities with a gamemode that matches the specified gamemode.

Optionallocation

location?: Vector3

Remarks

Adds a seed location to the query that is used in conjunction with closest, farthest, limit, volume, and distance properties.

OptionalmaxDistance

maxDistance?: number

Remarks

If specified, includes entities that are less than this distance away from the location specified in the location property.

OptionalmaxHorizontalRotation

maxHorizontalRotation?: number

Remarks

If specified, will only include entities that have at most this horizontal rotation.

OptionalmaxLevel

maxLevel?: number

Remarks

If defined, only players that have at most this level are returned.

OptionalmaxVerticalRotation

maxVerticalRotation?: number

Remarks

If specified, only entities that have at most this vertical rotation are returned.

OptionalminDistance

minDistance?: number

Remarks

If specified, includes entities that are least this distance away from the location specified in the location property.

OptionalminHorizontalRotation

minHorizontalRotation?: number

Remarks

If specified, will only include entities that have at a minimum this horizontal rotation.

OptionalminLevel

minLevel?: number

Remarks

If defined, only players that have at least this level are returned.

OptionalminVerticalRotation

minVerticalRotation?: number

Remarks

If specified, will only include entities that have at least this vertical rotation.

Optionalname

name?: string

Remarks

Includes entities with the specified name.

OptionalscoreOptions

scoreOptions?: EntityQueryScoreOptions[]

Remarks

Gets/sets a collection of EntityQueryScoreOptions objects with filters for specific scoreboard objectives.

Optionaltags

tags?: string[]

Remarks

Includes entities that match all of the specified tags.

Optionaltype

type?: string

Remarks

If defined, entities that match this type are included.

Settings

Member Visibility

On This Page

Properties