SanderMertens / flecs

A fast entity component system (ECS) for C & C++

Home Page:https://www.flecs.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Query Documentation Out of Date for C

MrFrenik opened this issue · comments

The QuickStart documentation section for queries needs to be updated to reflect the current build. The query struct
now wraps the terms in the ecs_filter_desc_t struct.

Before:

ecs_query_t *q = ecs_query_init(world, &(ecs_query_desc_t) {
    .terms = {
        { ecs_id(Position) },
        { ecs_id(Position), .subj.set = {
            .mask = EcsCascade,    // Force breadth-first order
            .relation = EcsChildOf // Use ChildOf relation for ordering
        }} 
    }
});

After:

ecs_query_t *q = ecs_query_init(world, &(ecs_query_desc_t) {
    .filter.terms = {
        { ecs_id(Position) },
        { ecs_id(Position), .subj.set = {
            .mask = EcsCascade,    // Force breadth-first order
            .relation = EcsChildOf // Use ChildOf relation for ordering
        }} 
    }
});

Fixed!