Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
Has, Owns, Shares
C API » Macro API » Type-Safe API » Entity API
Collaboration diagram for Has, Owns, Shares:

Macros

#define ecs_has(world, entity, T)
 Test if an entity has a component.
#define ecs_has_pair(world, entity, first, second)
 Test if an entity has a pair.
#define ecs_owns_pair(world, entity, first, second)
 Test if an entity owns a pair.
#define ecs_owns(world, entity, T)
 Test if an entity owns a component.
#define ecs_shares_id(world, entity, id)
 Test if an entity shares a component.
#define ecs_shares_pair(world, entity, first, second)
 Test if an entity shares a pair.
#define ecs_shares(world, entity, T)
 Test if an entity shares a component.
#define ecs_get_target_for(world, entity, rel, T)
 Get the target for a relationship.

Detailed Description

Macro Definition Documentation

◆ ecs_get_target_for

#define ecs_get_target_for ( world,
entity,
rel,
T )
Value:
ecs_get_target_for_id(world, entity, rel, ecs_id(T))
ecs_id
FLECS_API const ecs_entity_t ecs_id(EcsDocDescription)
Component ID for EcsDocDescription.
ecs_get_target_for_id
ecs_entity_t ecs_get_target_for_id(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, ecs_id_t component)
Get the target of a relationship for a given component.

Get the target for a relationship.

Definition at line 559 of file flecs_c.h.

◆ ecs_has

#define ecs_has ( world,
entity,
T )
Value:
ecs_has_id(world, entity, ecs_id(T))
ecs_has_id
bool ecs_has_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Test if an entity has a component.

Test if an entity has a component.

Definition at line 530 of file flecs_c.h.

◆ ecs_has_pair

#define ecs_has_pair ( world,
entity,
first,
second )
Value:
ecs_has_id(world, entity, ecs_pair(first, second))

Test if an entity has a pair.

Definition at line 534 of file flecs_c.h.

◆ ecs_owns

#define ecs_owns ( world,
entity,
T )
Value:
ecs_owns_id(world, entity, ecs_id(T))
ecs_owns_id
bool ecs_owns_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Test if an entity owns a component.

Test if an entity owns a component.

Definition at line 542 of file flecs_c.h.

◆ ecs_owns_pair

#define ecs_owns_pair ( world,
entity,
first,
second )
Value:
ecs_owns_id(world, entity, ecs_pair(first, second))

Test if an entity owns a pair.

Definition at line 538 of file flecs_c.h.

◆ ecs_shares

#define ecs_shares ( world,
entity,
T )
Value:
(ecs_shares_id(world, entity, ecs_id(T)))
ecs_shares_id
#define ecs_shares_id(world, entity, id)
Test if an entity shares a component.
Definition flecs_c.h:546

Test if an entity shares a component.

Definition at line 555 of file flecs_c.h.

◆ ecs_shares_id

#define ecs_shares_id ( world,
entity,
id )
Value:
(ecs_search_relation(world, ecs_get_table(world, entity), 0, ecs_id(id), \
EcsIsA, 1, 0, 0, 0, 0) != -1)
EcsIsA
const ecs_entity_t EcsIsA
Used to express inheritance relationships.
ecs_get_table
ecs_table_t * ecs_get_table(const ecs_world_t *world, ecs_entity_t entity)
Get the table of an entity.
ecs_search_relation
int32_t ecs_search_relation(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t component, ecs_entity_t rel, ecs_flags64_t flags, ecs_entity_t *tgt_out, ecs_id_t *component_out, struct ecs_table_record_t **tr_out)
Search for a component or relationship ID in a table type starting from an offset.

Test if an entity shares a component.

Definition at line 546 of file flecs_c.h.

◆ ecs_shares_pair

#define ecs_shares_pair ( world,
entity,
first,
second )
Value:
(ecs_shares_id(world, entity, ecs_pair(first, second)))

Test if an entity shares a pair.

Definition at line 551 of file flecs_c.h.