For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server/interfaces/BlockQueryOptions.md.

Interface: BlockQueryOptions experimental

block

Beta

在体积中查询方块的选项。扩展了 BlockFilter,增加了基于距离坐标的额外排序和限制选项。

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

Extends

Properties

closest?

optional closest?: number

Beta

Remarks

如果指定,则返回距离坐标最近的 N 个方块。必须大于 0。不能与 farthest 同时使用。需要设置 location

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?

optional excludePermutations?: BlockPermutation[]

Beta

Remarks

如果匹配其中任何一个,过滤器应拒绝的方块置换数组。

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

Inherited from

BlockFilter.excludePermutations


excludeTags?

optional excludeTags?: string[]

Beta

Remarks

如果匹配其中任何一个,过滤器应拒绝的方块标签数组。

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

Inherited from

BlockFilter.excludeTags


excludeTypes?

optional excludeTypes?: string[]

Beta

Remarks

如果匹配其中任何一个,过滤器应拒绝的方块类型数组。

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

Inherited from

BlockFilter.excludeTypes


farthest?

optional farthest?: number

Beta

Remarks

如果指定,则返回距离坐标最远的 N 个方块。必须大于 0。不能与 closest 同时使用。需要设置 location

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?

optional includePermutations?: BlockPermutation[]

Beta

Remarks

如果至少匹配其中一个,过滤器应选择的方块置换数组。

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

Inherited from

BlockFilter.includePermutations


includeTags?

optional includeTags?: string[]

Beta

Remarks

如果至少匹配其中一个,过滤器应选择的方块标签数组。

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

Inherited from

BlockFilter.includeTags


includeTypes?

optional includeTypes?: string[]

Beta

Remarks

如果至少匹配其中一个,过滤器应选择的方块类型数组。

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

Inherited from

BlockFilter.includeTypes


location?

optional location?: Vector3

Beta

Remarks

用作最近或最远距离计算的参考点位置。当指定了 closestfarthest 时需要设置。

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

同领域相关