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

Macros

#define ecs_lookup_from(world, parent, path)
 Lookup an entity from a parent.
#define ecs_get_path_from(world, parent, child)
 Get path from a parent.
#define ecs_get_path(world, child)
 Get path from root.
#define ecs_get_path_buf(world, child, buf)
 Get path from root, write to buffer.
#define ecs_new_from_path(world, parent, path)
 Create a new entity from a path.
#define ecs_add_path(world, entity, parent, path)
 Add a path to an entity.
#define ecs_add_fullpath(world, entity, path)
 Add a full path to an entity.

Detailed Description

Macro Definition Documentation

◆ ecs_add_fullpath

#define ecs_add_fullpath ( world,
entity,
path )
Value:
ecs_add_path_w_sep(world, entity, 0, path, ".", NULL)
ecs_add_path_w_sep
ecs_entity_t ecs_add_path_w_sep(ecs_world_t *world, ecs_entity_t entity, ecs_entity_t parent, const char *path, const char *sep, const char *prefix)
Add a specified path to an entity.

Add a full path to an entity.

Definition at line 617 of file flecs_c.h.

◆ ecs_add_path

#define ecs_add_path ( world,
entity,
parent,
path )
Value:
ecs_add_path_w_sep(world, entity, parent, path, ".", NULL)

Add a path to an entity.

Definition at line 613 of file flecs_c.h.

◆ ecs_get_path

#define ecs_get_path ( world,
child )
Value:
ecs_get_path_w_sep(world, 0, child, ".", NULL)
ecs_get_path_w_sep
char * ecs_get_path_w_sep(const ecs_world_t *world, ecs_entity_t parent, ecs_entity_t child, const char *sep, const char *prefix)
Get a path identifier for an entity.

Get path from root.

Definition at line 601 of file flecs_c.h.

◆ ecs_get_path_buf

#define ecs_get_path_buf ( world,
child,
buf )
Value:
ecs_get_path_w_sep_buf(world, 0, child, ".", NULL, buf, false)
ecs_get_path_w_sep_buf
void ecs_get_path_w_sep_buf(const ecs_world_t *world, ecs_entity_t parent, ecs_entity_t child, const char *sep, const char *prefix, ecs_strbuf_t *buf, bool escape)
Write a path identifier to a buffer.

Get path from root, write to buffer.

Definition at line 605 of file flecs_c.h.

◆ ecs_get_path_from

#define ecs_get_path_from ( world,
parent,
child )
Value:
ecs_get_path_w_sep(world, parent, child, ".", NULL)

Get path from a parent.

Definition at line 597 of file flecs_c.h.

◆ ecs_lookup_from

#define ecs_lookup_from ( world,
parent,
path )
Value:
ecs_lookup_path_w_sep(world, parent, path, ".", NULL, true)
ecs_lookup_path_w_sep
ecs_entity_t ecs_lookup_path_w_sep(const ecs_world_t *world, ecs_entity_t parent, const char *path, const char *sep, const char *prefix, bool recursive)
Look up an entity from a path.

Lookup an entity from a parent.

Definition at line 593 of file flecs_c.h.

◆ ecs_new_from_path

#define ecs_new_from_path ( world,
parent,
path )
Value:
ecs_new_from_path_w_sep(world, parent, path, ".", NULL)
ecs_new_from_path_w_sep
ecs_entity_t ecs_new_from_path_w_sep(ecs_world_t *world, ecs_entity_t parent, const char *path, const char *sep, const char *prefix)
Find or create an entity from a path.

Create a new entity from a path.

Definition at line 609 of file flecs_c.h.