Query

A World contains entities which have components. The World is queryable and can be used to get entities with a specific set of components.

Methods

iter

Returns an iterator that can be used to iterate over the query.

function Query:iter(): () -> (Entity, ...)

with

Adds components (IDs) to query with, but will not use their data. This is useful for Tags or generally just data you do not care for.

function Query:with(
    ...: Entity -- The IDs to query with
): Query

Example:

luau

for id, position in world:query(Position):with(Velocity) do
    -- Do something
end

typescript

for (const [id, position] of world.query(Position).with(Velocity)) {
	// Do something
}

INFO

Put the IDs inside of world:query() instead if you need the data.

without

Removes entities with the provided components from the query.

function Query:without(
    ...: Entity -- The IDs to filter against.
): Query -- Returns the Query

Example:

luau

for entity, position in world:query(Position):without(Velocity) do
    -- Do something
end

typescript

for (const [entity, position] of world.query(Position).without(Velocity)) {
	// Do something
}

archetypes

Returns the matching archetypes of the query.

function Query:archetypes(): { Archetype }

Example:

for i, archetype in world:query(Position, Velocity):archetypes() do
    local columns = archetype.columns
    local field = archetype.records

    local P = field[Position]
    local V = field[Velocity]

    for row, entity in archetype.entities do
        local position = columns[P][row]
        local velocity = columns[V][row]
        -- Do something
    end
end

INFO

This function is meant for people who want to really customize their query behaviour at the archetype-level

cached

Returns a cached version of the query. This is useful if you want to iterate over the same query multiple times.

function Query:cached(): Query -- Returns the cached Query