Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs::alert< Components > Struct Template Reference
Inheritance diagram for flecs::alert< Components >:
[legend]

Public Member Functions

 alert (flecs::world_t *world, ecs_alert_desc_t *desc)
 
 entity ()
 Default constructor.
 
 entity (const flecs::world_t *world, flecs::entity_t id)
 Wrap an existing entity ID.
 
 entity (world_t *world)
 Create a new entity.
 
 entity (world_t *world, const char *name, const char *sep="::", const char *root_sep="::")
 Create a named entity.
 
 entity (world_t *world, flecs::entity_t parent, const char *name, const char *sep="::", const char *root_sep="::")
 Create a named entity for a parent using ChildOf hierarchy storage.
 
 entity (world_t *world, const flecs::Parent &parent, const char *name=nullptr)
 Create a named entity for a parent using Parent hierarchy storage.
 
 entity (entity_t id)
 Conversion from flecs::entity_t to flecs::entity.
 
- Public Member Functions inherited from flecs::entity
 entity ()
 Default constructor.
 
 entity (const flecs::world_t *world, flecs::entity_t id)
 Wrap an existing entity ID.
 
 entity (world_t *world)
 Create a new entity.
 
 entity (world_t *world, const char *name, const char *sep="::", const char *root_sep="::")
 Create a named entity.
 
 entity (world_t *world, flecs::entity_t parent, const char *name, const char *sep="::", const char *root_sep="::")
 Create a named entity for a parent using ChildOf hierarchy storage.
 
 entity (world_t *world, const flecs::Parent &parent, const char *name=nullptr)
 Create a named entity for a parent using Parent hierarchy storage.
 
 entity (entity_t id)
 Conversion from flecs::entity_t to flecs::entity.
 
template<typename T >
T & ensure () const
 Get mutable component value.
 
void * ensure (entity_t comp) const
 Get mutable component value (untyped).
 
template<typename First , typename Second , typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
A & ensure () const
 Get mutable reference for a pair.
 
template<typename First >
First & ensure (entity_t second) const
 Get mutable reference for the first element of a pair.
 
void * ensure (entity_t first, entity_t second) const
 Get mutable pointer for a pair (untyped).
 
template<typename Second >
Second & ensure_second (entity_t first) const
 Get mutable reference for the second element of a pair.
 
template<typename T >
void modified () const
 Signal that component was modified.
 
template<typename First , typename Second , typename A = actual_type_t<flecs::pair<First, Second>>>
void modified () const
 Signal that the first element of a pair was modified.
 
template<typename First >
void modified (entity_t second) const
 Signal that the first part of a pair was modified.
 
void modified (entity_t first, entity_t second) const
 Signal that a pair has been modified (untyped).
 
void modified (entity_t comp) const
 Signal that component was modified.
 
template<typename T , if_t< is_actual< T >::value > = 0>
ref< T > get_ref_w_id (flecs::id_t component) const
 Get reference to component specified by component ID.
 
template<typename T , if_t< is_actual< T >::value > = 0>
ref< T > get_ref () const
 Get reference to component.
 
template<typename T , typename A = actual_type_t<T>, if_t< flecs::is_pair< T >::value > = 0>
ref< A > get_ref () const
 Get reference to component.
 
template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>>
ref< A > get_ref () const
 Get reference to pair component.
 
template<typename First >
ref< First > get_ref (flecs::entity_t second) const
 Get reference to the first element of a pair.
 
untyped_ref get_ref (flecs::id_t component) const
 Get untyped reference to component by component ID.
 
untyped_ref get_ref (flecs::id_t first, flecs::id_t second) const
 Get untyped reference to pair by first and second entity IDs.
 
template<typename Second >
ref< Second > get_ref_second (flecs::entity_t first) const
 Get reference to the second element of a pair.
 
void clear () const
 Clear an entity.
 
void destruct () const
 Delete an entity.
 
template<typename ... Args>
flecs::entity child (flecs::entity_t r=flecs::ChildOf, Args &&... args)
 Create a child entity with a specified relationship.
 
template<typename R , typename ... Args>
flecs::entity child (Args &&... args)
 Create a child entity with a typed relationship.
 
void set_child_order (flecs::entity_t *children, int32_t child_count) const
 Set child order.
 
flecs::entity_view view () const
 Return the entity as an entity_view.
 
const char * from_json (const char *json)
 Deserialize an entity from JSON.
 
- Public Member Functions inherited from flecs::entity_builder< entity >
const entityadd () const
 Add a component to an entity.
 
const entityadd (E value) const
 Add a pair for an enum constant.
 
const entityadd (id_t component) const
 Add an entity to an entity.
 
const entityadd (entity_t first, entity_t second) const
 Add a pair.
 
const entityadd () const
 Add a pair.
 
const entityadd (Second second) const
 Add a pair.
 
const entityadd (Second constant) const
 Add a pair.
 
const entityadd_second (flecs::entity_t first) const
 Add a pair.
 
const entityadd_if (bool cond, flecs::id_t component) const
 Conditional add.
 
const entityadd_if (bool cond) const
 Conditional add.
 
const entityadd_if (bool cond, flecs::entity_t first, flecs::entity_t second) const
 Conditional add.
 
const entityadd_if (bool cond, flecs::entity_t second) const
 Conditional add.
 
const entityadd_if (bool cond) const
 Conditional add.
 
const entityadd_if (bool cond, E constant) const
 Conditional add.
 
const entityis_a (entity_t second) const
 Shortcut for add(IsA, entity).
 
const entityis_a () const
 Shortcut for add(IsA, entity).
 
const entitychild_of (entity_t second) const
 Shortcut for add(ChildOf, entity).
 
const entitychild_of () const
 Shortcut for add(ChildOf, entity).
 
const entitydepends_on (entity_t second) const
 Shortcut for add(DependsOn, entity).
 
const entitydepends_on (E second) const
 Shortcut for add(DependsOn, entity).
 
const entitydepends_on () const
 Shortcut for add(DependsOn, entity).
 
const entityslot_of (entity_t second) const
 Shortcut for add(SlotOf, entity).
 
const entityslot_of () const
 Shortcut for add(SlotOf, entity).
 
const entityslot () const
 Shortcut for add(SlotOf, target(ChildOf)).
 
const entityremove () const
 Remove a component from an entity.
 
const entityremove (entity_t entity) const
 Remove an entity from an entity.
 
const entityremove (entity_t first, entity_t second) const
 Remove a pair.
 
const entityremove () const
 Remove a pair.
 
const entityremove (Second second) const
 Remove a pair.
 
const entityremove (Second constant) const
 Remove a pair.
 
const entityremove_second (flecs::entity_t first) const
 Remove a pair.
 
const entityauto_override (flecs::id_t id) const
 Mark ID for auto-overriding.
 
const entityauto_override (flecs::entity_t first, flecs::entity_t second) const
 Mark pair for auto-overriding.
 
const entityauto_override () const
 Mark component for auto-overriding.
 
const entityauto_override (flecs::entity_t second) const
 Mark pair for auto-overriding.
 
const entityauto_override () const
 Mark pair for auto-overriding.
 
const entityauto_override_second (flecs::entity_t first) const
 Mark pair for auto-overriding.
 
const entityset_auto_override (const T &val) const
 Set component, mark component for auto-overriding.
 
const entityset_auto_override (T &&val) const
 Set component, mark component for auto-overriding.
 
const entityset_auto_override (flecs::entity_t second, const First &val) const
 Set pair, mark pair for auto-overriding.
 
const entityset_auto_override (flecs::entity_t second, First &&val) const
 Set pair, mark pair for auto-overriding.
 
const entityset_auto_override (const A &val) const
 Set pair, mark pair for auto-overriding.
 
const entityset_auto_override (A &&val) const
 Set pair, mark pair for auto-overriding.
 
const entityemplace_auto_override (Args &&... args) const
 Emplace component, mark component for auto-overriding.
 
const entityemplace_auto_override (Args &&... args) const
 Emplace pair, mark pair for auto-overriding.
 
const entityenable () const
 Enable an entity.
 
const entityenable (flecs::id_t id, bool toggle=true) const
 Enable an ID.
 
const entityenable () const
 Enable a component.
 
const entityenable (flecs::id_t first, flecs::id_t second) const
 Enable a pair.
 
const entityenable (flecs::id_t second) const
 Enable a pair.
 
const entityenable () const
 Enable a pair.
 
const entitydisable () const
 Disable an entity.
 
const entitydisable (flecs::id_t id) const
 Disable an ID.
 
const entitydisable () const
 Disable a component.
 
const entitydisable (flecs::id_t first, flecs::id_t second) const
 Disable a pair.
 
const entitydisable (flecs::id_t second) const
 Disable a pair.
 
const entitydisable () const
 Disable a pair.
 
const entityset_ptr (entity_t comp, size_t size, const void *ptr) const
 
const entityset_ptr (entity_t comp, const void *ptr) const
 
const entityset (T &&value) const
 Set a component for an entity.
 
const entityset (const T &value) const
 Set a component for an entity.
 
const entityset (A &&value) const
 Set a component for an entity.
 
const entityset (const A &value) const
 Set a component for an entity.
 
const entityset (A &&value) const
 Set a pair for an entity.
 
const entityset (const A &value) const
 Set a pair for an entity.
 
const entityset (Second second, const First &value) const
 Set a pair for an entity.
 
const entityset (Second second, First &&value) const
 Set a pair for an entity.
 
const entityset (Second constant, const First &value) const
 Set a pair for an entity.
 
const entityset_second (entity_t first, const Second &value) const
 Set a pair for an entity.
 
const entityset_second (entity_t first, Second &&value) const
 Set a pair for an entity.
 
const entityset_second (const Second &value) const
 Set a pair for an entity.
 
const entityassign (T &&value) const
 Assign a component for an entity.
 
const entityassign (const T &value) const
 Assign a component for an entity.
 
const entityassign (A &&value) const
 Assign a component for an entity.
 
const entityassign (const A &value) const
 Assign a component for an entity.
 
const entityassign (A &&value) const
 Assign a pair for an entity.
 
const entityassign (const A &value) const
 Assign a pair for an entity.
 
const entityassign (Second second, const First &value) const
 Assign a pair for an entity.
 
const entityassign (Second second, First &&value) const
 Assign a pair for an entity.
 
const entityassign (Second constant, const First &value) const
 Assign a pair for an entity.
 
const entityassign_second (entity_t first, const Second &value) const
 Assign a pair for an entity.
 
const entityassign_second (entity_t first, Second &&value) const
 Assign a pair for an entity.
 
const entityassign_second (const Second &value) const
 
const entityinsert (const Func &func) const
 Set 1..N components.
 
const entityemplace (Args &&... args) const
 Emplace a component.
 
const entityemplace (Args &&... args) const
 
const entityemplace_first (flecs::entity_t second, Args &&... args) const
 
const entityemplace_second (flecs::entity_t first, Args &&... args) const
 
const entitywith (const Func &func) const
 Entities created in the function will have the current entity.
 
const entitywith (const Func &func) const
 Entities created in the function will have (First, this).
 
const entitywith (entity_t first, const Func &func) const
 Entities created in the function will have (first, this).
 
const entityscope (const Func &func) const
 The function will be run with the scope set to the current entity.
 
scoped_world scope () const
 Return a world scoped to the entity.
 
const entityset_name (const char *name) const
 Set the entity name.
 
const entityset_alias (const char *name) const
 Set the entity alias.
 
const entityset_doc_name (const char *name) const
 Set human-readable name.
 
const entityset_doc_brief (const char *brief) const
 Set brief description.
 
const entityset_doc_detail (const char *detail) const
 Set detailed description.
 
const entityset_doc_link (const char *link) const
 Set link to external documentation.
 
const entityset_doc_color (const char *color) const
 Set doc color.
 
const entityset_doc_uuid (const char *uuid) const
 Set doc UUID.
 
const entityobserve (flecs::entity_t evt, Func &&callback) const
 Observe an event on an entity.
 
const entityobserve (Func &&callback) const
 Observe an event on an entity.
 
const entityobserve (Func &&callback) const
 Observe an event on an entity.
 
const entityset_json (flecs::id_t e, const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a component from JSON.
 
const entityset_json (flecs::entity_t r, flecs::entity_t t, const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a pair from JSON.
 
const entityset_json (const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a component from JSON.
 
const entityset_json (const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a pair from JSON.
 
const entityset_json (flecs::entity_t t, const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a pair from JSON.
 
const entityset_json_second (flecs::entity_t r, const char *json, flecs::from_json_desc_t *desc=nullptr) const
 Set a pair from JSON.
 
 entity_view ()
 Default constructor.
 
 entity_view (flecs::world_t *world, flecs::id_t id)
 Wrap an existing entity ID.
 
 entity_view (entity_t id)
 Implicit conversion from flecs::entity_t to flecs::entity_view.
 
const entityunit (const char *symbol, flecs::entity_t prefix=0, flecs::entity_t base=0, flecs::entity_t over=0, int32_t factor=0, int32_t power=0) const
 Make an entity a unit.
 
- Public Member Functions inherited from flecs::entity_view
 entity_view ()
 Default constructor.
 
 entity_view (flecs::world_t *world, flecs::id_t id)
 Wrap an existing entity ID.
 
 entity_view (entity_t id)
 Implicit conversion from flecs::entity_t to flecs::entity_view.
 
entity_t id () const
 Get entity ID.
 
bool is_valid () const
 Check if entity is valid.
 
 operator bool () const
 Conversion to bool.
 
bool is_alive () const
 Check if entity is alive.
 
flecs::string_view name () const
 Return the entity name.
 
flecs::string_view symbol () const
 Return the entity symbol.
 
flecs::string path (const char *sep="::", const char *init_sep="::") const
 Return the entity path.
 
flecs::string path_from (flecs::entity_t parent, const char *sep="::", const char *init_sep="::") const
 Return the entity path relative to a parent.
 
template<typename Parent >
flecs::string path_from (const char *sep="::", const char *init_sep="::") const
 Return the entity path relative to a typed parent.
 
bool enabled () const
 Check if entity is enabled (does not have the Disabled tag).
 
flecs::type type () const
 Get the entity's type.
 
flecs::table table () const
 Get the entity's table.
 
flecs::table_range range () const
 Get table range for the entity.
 
template<typename Func >
void each (const Func &func) const
 Iterate (component) IDs of an entity.
 
template<typename Func >
void each (flecs::id_t first, flecs::id_t second, const Func &func) const
 Iterate matching pair IDs of an entity.
 
template<typename Func >
void each (const flecs::entity_view &rel, const Func &func) const
 Iterate targets for a given relationship.
 
template<typename First , typename Func >
void each (const Func &func) const
 Iterate targets for a given relationship.
 
template<typename Func >
void children (flecs::entity_t rel, Func &&func) const
 Iterate children for an entity.
 
template<typename Rel , typename Func >
void children (Func &&func) const
 Iterate children for an entity.
 
template<typename Func >
void children (Func &&func) const
 Iterate children for an entity.
 
template<typename T , if_t< is_actual< T >::value > = 0>
const T * try_get () const
 Get component value.
 
template<typename T , typename A = actual_type_t<T>, if_t< flecs::is_pair< T >::value > = 0>
const A * try_get () const
 Get component value.
 
template<typename First , typename Second , typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
const A * try_get () const
 Get a pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
const First * try_get (Second second) const
 Get a pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value &&!std::is_same< First, Second >::value > = 0>
const First * try_get (Second constant) const
 Get a pair.
 
const void * try_get (flecs::id_t comp) const
 Get component value (untyped).
 
const void * try_get (flecs::entity_t first, flecs::entity_t second) const
 Get a pair (untyped).
 
template<typename... Ts>
auto try_get_n () const
 Get multiple component values as a tuple of const pointers.
 
template<typename Second >
const Second * try_get_second (flecs::entity_t first) const
 Get the second part for a pair.
 
template<typename First , typename Second >
const Second * try_get_second () const
 Get the second part for a pair.
 
template<typename T , if_t< is_actual< T >::value > = 0>
const T & get () const
 Get component value.
 
template<typename T , typename A = actual_type_t<T>, if_t< flecs::is_pair< T >::value > = 0>
const A & get () const
 Get component value.
 
template<typename First , typename Second , typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
const A & get () const
 Get a pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
const First & get (Second second) const
 Get a pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value &&!std::is_same< First, Second >::value > = 0>
const First & get (Second constant) const
 Get a pair.
 
const void * get (flecs::id_t comp) const
 Get component value (untyped).
 
const void * get (flecs::entity_t first, flecs::entity_t second) const
 Get a pair (untyped).
 
template<typename Func , if_t< is_callable< Func >::value > = 0>
bool get (const Func &func) const
 Get 1..N components.
 
template<typename... Ts>
auto get_n () const
 Get multiple component values as a tuple of const references.
 
template<typename Second >
const Second & get_second (flecs::entity_t first) const
 Get the second part for a pair.
 
template<typename First , typename Second >
const Second & get_second () const
 Get the second part for a pair.
 
template<typename T , if_t< is_actual< T >::value > = 0>
T * try_get_mut () const
 Get mutable component value.
 
template<typename T , typename A = actual_type_t<T>, if_t< flecs::is_pair< T >::value > = 0>
A * try_get_mut () const
 Get mutable component value.
 
template<typename First , typename Second , typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
A * try_get_mut () const
 Get a mutable pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
First * try_get_mut (Second second) const
 Get a mutable pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value &&!std::is_same< First, Second >::value > = 0>
First * try_get_mut (Second constant) const
 Get a mutable pair.
 
void * try_get_mut (flecs::id_t comp) const
 Get mutable component value (untyped).
 
void * try_get_mut (flecs::entity_t first, flecs::entity_t second) const
 Get a mutable pair (untyped).
 
template<typename... Ts>
auto try_get_mut_n () const
 Get multiple mutable component values as a tuple of pointers.
 
template<typename Second >
Second * try_get_mut_second (flecs::entity_t first) const
 Get the second part for a pair.
 
template<typename First , typename Second >
Second * try_get_mut_second () const
 Get the second part for a pair.
 
template<typename T , if_t< is_actual< T >::value > = 0>
T & get_mut () const
 Get mutable component value.
 
template<typename T , typename A = actual_type_t<T>, if_t< flecs::is_pair< T >::value > = 0>
A & get_mut () const
 Get mutable component value.
 
template<typename First , typename Second , typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
A & get_mut () const
 Get a mutable pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
First & get_mut (Second second) const
 Get a mutable pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value &&!std::is_same< First, Second >::value > = 0>
First & get_mut (Second constant) const
 Get a mutable pair.
 
void * get_mut (flecs::id_t comp) const
 Get mutable component value (untyped).
 
void * get_mut (flecs::entity_t first, flecs::entity_t second) const
 Get a mutable pair (untyped).
 
template<typename... Ts>
auto get_mut_n () const
 Get multiple mutable component values as a tuple of references.
 
template<typename Second >
Second & get_mut_second (flecs::entity_t first) const
 Get the second part for a pair.
 
template<typename First , typename Second >
Second & get_mut_second () const
 Get the second part for a pair.
 
template<typename Enum >
Enum get_constant () const
 Get enum constant for enum relationship.
 
template<typename First >
flecs::entity target (int32_t index=0) const
 Get target for a given pair.
 
flecs::entity target (flecs::entity_t first, int32_t index=0) const
 Get target for a given pair.
 
flecs::entity target_for (flecs::entity_t relationship, flecs::id_t id) const
 Get the target of a pair for a given relationship ID.
 
template<typename T >
flecs::entity target_for (flecs::entity_t relationship) const
 Get the target of a pair for a given relationship ID.
 
template<typename First , typename Second >
flecs::entity target_for (flecs::entity_t relationship) const
 Get the target of a pair for a given relationship ID.
 
int32_t depth (flecs::entity_t rel) const
 Get the depth for a given relationship.
 
template<typename Rel >
int32_t depth () const
 Get the depth for a given relationship.
 
flecs::entity parent () const
 Get parent of entity.
 
flecs::entity lookup (const char *path, bool search_path=false) const
 Lookup an entity by name.
 
bool has (flecs::id_t e) const
 Check if entity has the provided entity.
 
template<typename T >
bool has () const
 Check if entity has the provided component.
 
template<typename E , if_t< is_enum< E >::value > = 0>
bool has (E value) const
 Check if entity has the provided enum constant.
 
template<typename First , typename Second >
bool has () const
 Check if entity has the provided pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
bool has (Second second) const
 Check if entity has the provided pair.
 
template<typename Second >
bool has_second (flecs::entity_t first) const
 Check if entity has the provided pair.
 
template<typename First , typename E , if_t< is_enum< E >::value &&!std::is_same< First, E >::value > = 0>
bool has (E value) const
 Check if entity has the provided pair.
 
bool has (flecs::id_t first, flecs::id_t second) const
 Check if entity has the provided pair.
 
bool owns (flecs::id_t e) const
 Check if entity owns the provided entity.
 
template<typename First >
bool owns (flecs::id_t second) const
 Check if entity owns the provided pair.
 
bool owns (flecs::id_t first, flecs::id_t second) const
 Check if entity owns the provided pair.
 
template<typename T >
bool owns () const
 Check if entity owns the provided component.
 
template<typename First , typename Second >
bool owns () const
 Check if entity owns the provided pair.
 
template<typename Second >
bool owns_second (flecs::entity_t first) const
 Check if entity owns the provided pair.
 
bool enabled (flecs::id_t id) const
 Test if ID is enabled.
 
template<typename T >
bool enabled () const
 Test if component is enabled.
 
bool enabled (flecs::id_t first, flecs::id_t second) const
 Test if pair is enabled.
 
template<typename First >
bool enabled (flecs::id_t second) const
 Test if pair is enabled.
 
template<typename First , typename Second >
bool enabled () const
 Test if pair is enabled.
 
flecs::entity clone (bool clone_value=true, flecs::entity_t dst_id=0) const
 Clone an entity.
 
flecs::entity mut (const flecs::world &stage) const
 Return a mutable entity handle for the current stage.
 
flecs::entity mut (const flecs::iter &it) const
 Same as mut(world), but for an iterator.
 
flecs::entity mut (const flecs::entity_view &e) const
 Same as mut(world), but for an entity.
 
int32_t alert_count (flecs::entity_t alert=0) const
 Return the number of alerts for an entity.
 
const char * doc_name () const
 Get human-readable name.
 
const char * doc_brief () const
 Get brief description.
 
const char * doc_detail () const
 Get detailed description.
 
const char * doc_link () const
 Get link to external documentation.
 
const char * doc_color () const
 Get color.
 
const char * doc_uuid () const
 Get UUID.
 
template<typename E >
to_constant () const
 Convert an entity to an enum constant.
 
void emit (flecs::entity_t evt) const
 Emit an event for an entity.
 
void emit (flecs::entity evt) const
 Emit an event for an entity.
 
template<typename Evt , if_t< is_empty< Evt >::value > = 0>
void emit () const
 Emit an event for an entity.
 
template<typename Evt , if_not_t< is_empty< Evt >::value > = 0>
void emit (const Evt &payload) const
 Emit an event with payload for an entity.
 
void enqueue (flecs::entity_t evt) const
 Enqueue an event for an entity.
 
void enqueue (flecs::entity evt) const
 Enqueue an event for an entity.
 
template<typename Evt , if_t< is_empty< Evt >::value > = 0>
void enqueue () const
 Enqueue an event for an entity.
 
template<typename Evt , if_not_t< is_empty< Evt >::value > = 0>
void enqueue (const Evt &payload) const
 Enqueue an event with payload for an entity.
 
flecs::string to_json (const flecs::entity_to_json_desc_t *desc=nullptr) const
 Serialize an entity to JSON.
 
- Public Member Functions inherited from flecs::id
 id (flecs::id_t value)
 
 id (flecs::world_t *world, flecs::id_t value=0)
 
 id (flecs::world_t *world, flecs::id_t first, flecs::id_t second)
 
 id (flecs::world_t *world, const char *expr)
 
 id (flecs::id_t first, flecs::id_t second)
 
 id (const flecs::id &first, const flecs::id &second)
 
bool is_pair () const
 Test if ID is a pair (has first, second).
 
bool is_wildcard () const
 Test if ID is a wildcard.
 
bool is_entity () const
 Test if ID is an entity.
 
flecs::entity entity () const
 Return ID as entity (only allowed when ID is a valid entity).
 
flecs::entity add_flags (flecs::id_t flags) const
 Return ID with flags added.
 
flecs::entity remove_flags (flecs::id_t flags) const
 Return ID with flags removed.
 
flecs::entity remove_flags () const
 Return ID without flags.
 
flecs::entity remove_generation () const
 Return ID without generation.
 
flecs::entity type_id () const
 Return component type of ID.
 
bool has_flags (flecs::id_t flags) const
 Test if ID has specified flags.
 
bool has_flags () const
 Test if ID has any flags.
 
flecs::entity flags () const
 Return ID flags set on ID.
 
bool has_relation (flecs::id_t first) const
 Test if ID has the specified first element.
 
flecs::entity first () const
 Get first element from a pair.
 
flecs::entity second () const
 Get second element from a pair.
 
flecs::string str () const
 Convert ID to string.
 
flecs::string flags_str () const
 Convert flags of ID to string.
 
flecs::id_t raw_id () const
 Return flecs::id_t value.
 
 operator flecs::id_t () const
 
flecs::world world () const
 Get the world.
 

Additional Inherited Members

- Static Public Member Functions inherited from flecs::entity
static flecs::entity null (const flecs::world_t *world)
 Entity ID 0.
 
static flecs::entity null ()
 Entity ID 0 without a world.
 
- Protected Member Functions inherited from flecs::entity_builder< entity >
const entityto_base () const
 
- Protected Attributes inherited from flecs::id
flecs::world_tworld_
 World is optional, but guarantees that entity identifiers extracted from the ID are valid.
 
flecs::id_t id_
 The raw ID value.
 

Detailed Description

template<typename ... Components>
struct flecs::alert< Components >

Definition at line 13 of file impl.hpp.

Constructor & Destructor Documentation

◆ alert() [1/2]

template<typename ... Components>
flecs::alert< Components >::alert ( )
inlineexplicit

Definition at line 17 of file impl.hpp.

◆ alert() [2/2]

template<typename ... Components>
flecs::alert< Components >::alert ( flecs::world_t * world,
ecs_alert_desc_t * desc )
inlineexplicit

Definition at line 22 of file impl.hpp.

Member Function Documentation

◆ entity() [1/7]

template<typename ... Components>
flecs::entity::entity ( )
inline

Default constructor.

Creates an empty entity.

Definition at line 32 of file entity.hpp.

◆ entity() [2/7]

template<typename ... Components>
flecs::entity::entity ( const flecs::world_t * world,
flecs::entity_t id )
inlineexplicit

Wrap an existing entity ID.

Parameters
worldThe world in which the entity is created.
idThe entity ID.

Definition at line 39 of file entity.hpp.

◆ entity() [3/7]

template<typename ... Components>
flecs::entity::entity ( entity_t id)
inlineexplicit

Conversion from flecs::entity_t to flecs::entity.

Parameters
idThe entity_t value to convert.

Definition at line 124 of file entity.hpp.

◆ entity() [4/7]

template<typename ... Components>
flecs::entity::entity ( world_t * world)
inlineexplicit

Create a new entity.

Parameters
worldThe world in which to create the entity.

Definition at line 48 of file entity.hpp.

◆ entity() [5/7]

template<typename ... Components>
flecs::entity::entity ( world_t * world,
const char * name,
const char * sep = "::",
const char * root_sep = "::" )
inlineexplicit

Create a named entity.

Parameters
worldThe world in which to create the entity.
nameThe entity name.
sepString used to indicate scoping (Foo::Bar).
root_sepString used to indicate name is fully scoped (::Foo::Bar).

Definition at line 62 of file entity.hpp.

◆ entity() [6/7]

template<typename ... Components>
flecs::entity::entity ( world_t * world,
const flecs::Parent & parent,
const char * name = nullptr )
inlineexplicit

Create a named entity for a parent using Parent hierarchy storage.

The specified name cannot be a scoped identifier. For example:

  • OK: "Foo"
  • Not OK: "Foo::Bar"
Parameters
worldThe world in which to create the entity.
parentThe parent entity.
nameThe entity name (optional).

Definition at line 111 of file entity.hpp.

◆ entity() [7/7]

template<typename ... Components>
flecs::entity::entity ( world_t * world,
flecs::entity_t parent,
const char * name,
const char * sep = "::",
const char * root_sep = "::" )
inlineexplicit

Create a named entity for a parent using ChildOf hierarchy storage.

Parameters
worldThe world in which to create the entity.
parentThe parent entity ID.
nameThe entity name.
sepString used to indicate scoping (Foo::Bar).
root_sepString used to indicate name is fully scoped (::Foo::Bar).

Definition at line 85 of file entity.hpp.


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