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

Used with ecs_entity_init. More...

#include <flecs.h>

Public Attributes

int32_t _canary
 
ecs_entity_t id
 Set to modify existing entity (optional) More...
 
const char * name
 Name of the entity. More...
 
const char * sep
 Optional custom separator for hierarchical names. More...
 
const char * root_sep
 Optional, used for identifiers relative to root. More...
 
const char * symbol
 Optional entity symbol. More...
 
bool use_low_id
 When set to true, a low id (typically reserved for components) will be used to create the entity, if no id is specified. More...
 
ecs_id_t add [(32)]
 Array of ids to add to the new or existing entity. More...
 
const char * add_expr
 String expression with components to add. More...
 

Detailed Description

Used with ecs_entity_init.

Definition at line 685 of file flecs.h.

Member Data Documentation

◆ _canary

int32_t ecs_entity_desc_t::_canary

Definition at line 686 of file flecs.h.

◆ add

ecs_id_t ecs_entity_desc_t::add[(32)]

Array of ids to add to the new or existing entity.

Definition at line 716 of file flecs.h.

◆ add_expr

const char* ecs_entity_desc_t::add_expr

String expression with components to add.

Definition at line 719 of file flecs.h.

◆ id

ecs_entity_t ecs_entity_desc_t::id

Set to modify existing entity (optional)

Definition at line 688 of file flecs.h.

◆ name

const char* ecs_entity_desc_t::name

Name of the entity.

If no entity is provided, an entity with this name will be looked up first. When an entity is provided, the name will be verified with the existing entity.

Definition at line 690 of file flecs.h.

◆ root_sep

const char* ecs_entity_desc_t::root_sep

Optional, used for identifiers relative to root.

Definition at line 699 of file flecs.h.

◆ sep

const char* ecs_entity_desc_t::sep

Optional custom separator for hierarchical names.

Leave to NULL for default ('.') separator. Set to an empty string to prevent tokenization of name.

Definition at line 695 of file flecs.h.

◆ symbol

const char* ecs_entity_desc_t::symbol

Optional entity symbol.

A symbol is an unscoped identifier that can be used to lookup an entity. The primary use case for this is to associate the entity with a language identifier, such as a type or function name, where these identifiers differ from the name they are registered with in flecs. For example, C type "EcsPosition" might be registered as "flecs.components.transform.Position", with the symbol set to "EcsPosition".

Definition at line 701 of file flecs.h.

◆ use_low_id

bool ecs_entity_desc_t::use_low_id

When set to true, a low id (typically reserved for components) will be used to create the entity, if no id is specified.

Definition at line 711 of file flecs.h.


The documentation for this struct was generated from the following file: