Class Query<ReqTuple>

Query builder for component-based entity iteration 基于组件的实体遍历查询构建器

Type Parameters

ReqTuple extends unknown[] = unknown[]

Constructors

constructor

new Query<ReqTuple extends unknown[] = unknown[]>(
world: World,
required: ComponentType<unknown>[],
): Query<ReqTuple>
Type Parameters
- ReqTuple extends unknown[] = unknown[]
Parameters
- world: World
- required: ComponentType<unknown>[]
Returns Query<ReqTuple>
- Defined in core/Query.ts:97

Methods

_matchesEntity

_matchesEntity(entity: number): boolean
Check if an entity matches this query's requirements 检查实体是否匹配此查询的要求
Parameters
- entity: number
Returns boolean
- Defined in core/Query.ts:225

_notifyEntityAdded

_notifyEntityAdded(entity: number): void
Internal method to notify about entity additions 内部方法用于通知实体添加
Parameters
- entity: number
Returns void
- Defined in core/Query.ts:195

_notifyEntityChanged

_notifyEntityChanged(entity: number): void
Internal method to notify about entity changes 内部方法用于通知实体变更
Parameters
- entity: number
Returns void
- Defined in core/Query.ts:215

_notifyEntityRemoved

_notifyEntityRemoved(entity: number): void
Internal method to notify about entity removals 内部方法用于通知实体移除
Parameters
- entity: number
Returns void
- Defined in core/Query.ts:205

changed

changed<T>(...ctors: ComponentCtor<T>[]): Query<ReqTuple>
Only iterate entities where specified components changed this frame 仅迭代指定组件在本帧发生变化的实体
Type Parameters
- T
Parameters
- ...ctors: ComponentCtor<T>[]
Returns Query<ReqTuple>
- Defined in core/Query.ts:137

consumeDelta

consumeDelta(): QueryDelta
Consume and clear accumulated delta 消费并清空累积的增量

Returns QueryDelta
- Defined in core/Query.ts:173

count

count(): number
Count matching entities (fast path for simple counting) 计算匹配实体数量（简单计数的快路径）

Returns number
- Defined in core/Query.ts:667

enableDelta

enableDelta(): Query<ReqTuple>
Enable delta subscription for incremental updates 启用增量订阅以获取增量更新

Returns Query<ReqTuple>
- Defined in core/Query.ts:158

first

first(): undefined | [number, ...ReqTuple[]]
Get the first matching entity and its components 获取第一个匹配的实体及其组件

Returns undefined | [number, ...ReqTuple[]]
- Defined in core/Query.ts:724

forEach

forEach(callback: (entity: number, ...components: ReqTuple) => void): void
Iterate over matching entities with their components 遍历匹配的实体及其组件
Parameters
- callback: (entity: number, ...components: ReqTuple) => void
Returns void
- Defined in core/Query.ts:433

forEachRaw

forEachRaw(
    callback: (
        row: number,
        entities: number[],
        cols: any[][],
        optionalCols?: (undefined | any[])[],
    ) => void,
): void
Zero-allocation raw column iteration 零分配原始列遍历
Parameters
- callback: (
      row: number,
      entities: number[],
      cols: any[][],
      optionalCols?: (undefined | any[])[],
  ) => void
Returns void
- Defined in core/Query.ts:419

isDeltaEnabled

isDeltaEnabled(): boolean
Check if delta subscription is enabled 检查是否启用了增量订阅

Returns boolean
- Defined in core/Query.ts:187

map

map<R>(mapper: (entity: number, ...components: ReqTuple) => R): R[]
Map query results to an array (materialize for dev tools/debugging) 将查询结果映射为数组（物化用于开发工具/调试）
Type Parameters
- R
Parameters
- mapper: (entity: number, ...components: ReqTuple) => R
Returns R[]
- Defined in core/Query.ts:754

optional

optional<T>(...ctors: ComponentCtor<T>[]): Query<ReqTuple>
Add optional components (callback receives undefined if not present) 添加可选组件（如果不存在则回调接收undefined）
Type Parameters
- T
Parameters
- ...ctors: ComponentCtor<T>[]
Returns Query<ReqTuple>
- Defined in core/Query.ts:127

some

some(predicate?: (entity: number, ...components: ReqTuple) => boolean): boolean
Check if any entities match the query (optionally with predicate) 检查是否有实体匹配查询（可选谓词函数）
Parameters
- Optionalpredicate: (entity: number, ...components: ReqTuple) => boolean
Returns boolean
- Defined in core/Query.ts:692

toArray

toArray(): [number, ...ReqTuple[]][]
Collect all matching entities into an array 收集所有匹配的实体到数组中

Returns [number, ...ReqTuple[]][]
- Defined in core/Query.ts:766

toChunks

toChunks(targetChunkSize?: number): QueryChunkView[]
Generate chunk views for parallel processing 生成并行处理的分块视图
Parameters
- targetChunkSize: number = 4096
Returns QueryChunkView[]
- Defined in core/Query.ts:777

useArchetypeOptimization

useArchetypeOptimization(enabled: boolean): Query<ReqTuple>
Control whether to use archetype optimization (default: true) 控制是否使用archetype优化（默认：true）
Parameters
- enabled: boolean
Returns Query<ReqTuple>
- Defined in core/Query.ts:148

where

where(requireAll?: string[], forbidAny?: string[]): Query<ReqTuple>
Filter by tags: require all specified tags and forbid any of the forbidden tags 标签过滤：要求所有指定标签并禁止任何被禁止的标签
Parameters
- requireAll: string[] = []
- forbidAny: string[] = []
Returns Query<ReqTuple>
- Defined in core/Query.ts:115

without

without<T>(...ctors: ComponentCtor<T>[]): Query<ReqTuple>
Filter: exclude entities that have these components 过滤：排除含有这些组件的实体
Type Parameters
- T
Parameters
- ...ctors: ComponentCtor<T>[]
Returns Query<ReqTuple>
- Defined in core/Query.ts:105