Flecs v3.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
plecs.h File Reference

Plecs addon. More...

Go to the source code of this file.

Functions

FLECS_API int ecs_plecs_from_str (ecs_world_t *world, const char *name, const char *str)
 Parse plecs string.
 
FLECS_API int ecs_plecs_from_file (ecs_world_t *world, const char *filename)
 Parse plecs file.
 

Detailed Description

Plecs addon.

Plecs is a small data definition language for instantiating entities that reuses the existing flecs query parser. The following examples illustrate how a plecs snippet translates to regular flecs operations:

Plecs: Entity C code: ecs_entity_t Entity = ecs_set_name(world, 0, "Entity");

Plecs: Position(Entity) C code: ecs_entity_t Position = ecs_set_name(world, 0, "Position"); ecs_entity_t Entity = ecs_set_name(world, 0, "Entity"); ecs_add_id(world, Entity, Position);

Plecs: Likes(Entity, Apples) C code: ecs_entity_t Likes = ecs_set_name(world, 0, "Likes"); ecs_entity_t Apples = ecs_set_name(world, 0, "Apples"); ecs_entity_t Entity = ecs_set_name(world, 0, "Entity"); ecs_add_pair(world, Entity, Likes, Apples);

A plecs string may contain multiple statements, separated by a newline: Likes(Entity, Apples) Likes(Entity, Pears) Likes(Entity, Bananas)

Definition in file plecs.h.