Script API - v1.20.60
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    closest?: number

    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.

    excludeFamilies?: string[]

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

    excludeGameModes?: GameMode[]

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

    excludeNames?: string[]

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

    excludeTags?: string[]

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

    excludeTypes?: string[]

    Excludes entities if they are one of the specified types.

    families?: string[]

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

    farthest?: number

    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.

    gameMode?: GameMode

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

    location?: Vector3

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

    maxDistance?: number

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

    maxHorizontalRotation?: number

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

    maxLevel?: number

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

    maxVerticalRotation?: number

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

    minDistance?: number

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

    minHorizontalRotation?: number

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

    minLevel?: number

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

    minVerticalRotation?: number

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

    name?: string

    Includes entities with the specified name.

    scoreOptions?: EntityQueryScoreOptions[]

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

    tags?: string[]

    Includes entities that match all of the specified tags.

    type?: string

    If defined, entities that match this type are included.

    Settings

    Member Visibility

    On This Page

    Properties