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

    Interface BlockQueryOptionsBeta

    Options for querying blocks in a volume. Extends BlockFilter with additional sorting and limiting options based on distance from a location.

    interface BlockQueryOptions {
        closest?: number;
        excludePermutations?: BlockPermutation[];
        excludeTags?: string[];
        excludeTypes?: string[];
        farthest?: number;
        includePermutations?: BlockPermutation[];
        includeTags?: string[];
        includeTypes?: string[];
        location?: Vector3;
    }

    Hierarchy (View Summary)

    Index

    Properties

    closest? excludePermutations? excludeTags? excludeTypes? farthest? includePermutations? includeTags? includeTypes? location?

    Properties

    closest?: number

    If specified, returns the closest N blocks to the location. Must be greater than 0. Cannot be used with farthest. Requires location to be set.

    excludePermutations?: BlockPermutation[]

    Array of block permutations that the filter should reject if any matches.

    excludeTags?: string[]

    Array of block tags that the filter should reject if any matches.

    excludeTypes?: string[]

    Array of block types that the filter should reject if any matches.

    farthest?: number

    If specified, returns the farthest N blocks from the location. Must be greater than 0. Cannot be used with closest. Requires location to be set.

    includePermutations?: BlockPermutation[]

    Array of block permutations that the filter should select if at least one matches.

    includeTags?: string[]

    Array of block tags that the filter should select if at least one matches.

    includeTypes?: string[]

    Array of block types that the filter should select if at least one matches.

    location?: Vector3

    Location used as the reference point for closest or farthest distance calculations. Required when closest or farthest is specified.

    Settings

    Member Visibility

    On This Page

    Properties