Flecs v3.2
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs::entity_builder< Self > Struct Template Reference

Entity builder. More...

#include <builder.hpp>

Inheritance diagram for flecs::entity_builder< Self >:
[legend]

Public Member Functions

template<typename T >
Self & add ()
 Add a component to an entity.
 
template<typename E , if_t< is_enum< E >::value > = 0>
Self & add (E value)
 Add pair for enum constant.
 
Self & add (id_t component)
 Add an entity to an entity.
 
Self & add (entity_t first, entity_t second)
 Add a pair.
 
template<typename First , typename Second >
Self & add ()
 Add a pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & add (Second second)
 Add a pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & add (Second constant)
 Add a pair.
 
template<typename Second >
Self & add_second (flecs::entity_t first)
 Add a pair.
 
Self & add_if (bool cond, flecs::id_t component)
 Conditional add.
 
template<typename T >
Self & add_if (bool cond)
 Conditional add.
 
Self & add_if (bool cond, flecs::entity_t first, flecs::entity_t second)
 Conditional add.
 
template<typename First >
Self & add_if (bool cond, flecs::entity_t second)
 Conditional add.
 
template<typename First , typename Second >
Self & add_if (bool cond)
 Conditional add.
 
template<typename E , if_t< is_enum< E >::value > = 0>
Self & add_if (bool cond, E constant)
 Conditional add.
 
Self & is_a (entity_t second)
 Shortcut for add(IsA, entity).
 
template<typename T >
Self & is_a ()
 Shortcut for add(IsA, entity).
 
Self & child_of (entity_t second)
 Shortcut for add(ChildOf, entity).
 
Self & depends_on (entity_t second)
 Shortcut for add(DependsOn, entity).
 
template<typename E , if_t< is_enum< E >::value > = 0>
Self & depends_on (E second)
 Shortcut for add(DependsOn, entity).
 
Self & slot_of (entity_t second)
 Shortcut for add(SlotOf, entity).
 
Self & slot ()
 Shortcut for add(SlotOf, target(ChildOf)).
 
template<typename T >
Self & child_of ()
 Shortcut for add(ChildOf, entity).
 
template<typename T >
Self & depends_on ()
 Shortcut for add(DependsOn, entity).
 
template<typename T >
Self & slot_of ()
 Shortcut for add(SlotOf, entity).
 
template<typename T , if_not_t< is_enum< T >::value > = 0>
Self & remove ()
 Remove a component from an entity.
 
template<typename E , if_t< is_enum< E >::value > = 0>
Self & remove ()
 Remove pair for enum.
 
Self & remove (entity_t entity)
 Remove an entity from an entity.
 
Self & remove (entity_t first, entity_t second)
 Remove a pair.
 
template<typename First , typename Second >
Self & remove ()
 Removes a pair.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & remove (Second second)
 Remove a pair.
 
template<typename Second >
Self & remove_second (flecs::entity_t first)
 Removes a pair.
 
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & remove (Second constant)
 Remove a pair.
 
Self & override (flecs::id_t id)
 Mark id for auto-overriding.
 
Self & override (flecs::entity_t first, flecs::entity_t second)
 Mark pair for auto-overriding.
 
template<typename T >
Self & override ()
 Mark component for auto-overriding.
 
template<typename First >
Self & override (flecs::entity_t second)
 Mark pair for auto-overriding.
 
template<typename First , typename Second >
Self & override ()
 Mark pair for auto-overriding.
 
template<typename T >
Self & set_override (const T &val)
 Set component, mark component for auto-overriding.
 
template<typename T >
Self & set_override (T &&val)
 Set component, mark component for auto-overriding.
 
template<typename First >
Self & set_override (flecs::entity_t second, const First &val)
 Set pair, mark component for auto-overriding.
 
template<typename First >
Self & set_override (flecs::entity_t second, First &&val)
 Set pair, mark component for auto-overriding.
 
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>
Self & set_override (const A &val)
 Set component, mark component for auto-overriding.
 
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>
Self & set_override (A &&val)
 Set component, mark component for auto-overriding.
 
template<typename T , typename ... Args>
Self & emplace_override (Args &&... args)
 Emplace component, mark component for auto-overriding.
 
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, typename ... Args>
Self & emplace_override (Args &&... args)
 Emplace pair, mark pair for auto-overriding.
 
Self & enable ()
 Enable an entity.
 
Self & disable ()
 Disable an entity.
 
Self & enable (flecs::id_t id, bool toggle=true)
 Enable an id.
 
template<typename T >
Self & enable ()
 Enable a component.
 
Self & enable (flecs::id_t first, flecs::id_t second)
 Enable a pair.
 
template<typename First >
Self & enable (flecs::id_t second)
 Enable a pair.
 
template<typename First , typename Second >
Self & enable ()
 Enable a pair.
 
Self & disable (flecs::id_t id)
 Disable an id.
 
template<typename T >
Self & disable ()
 Disable a component.
 
Self & disable (flecs::id_t first, flecs::id_t second)
 Disable a pair.
 
template<typename First >
Self & disable (flecs::id_t second)
 Disable a pair.
 
template<typename First , typename Second >
Self & disable ()
 Disable a pair.
 
Self & set_ptr (entity_t comp, size_t size, const void *ptr)
 
Self & set_ptr (entity_t comp, const void *ptr)
 
template<typename T , if_t< !is_callable< T >::value &&is_actual< T >::value > = 0>
Self & set (T &&value)
 
template<typename T , if_t< !is_callable< T >::value &&is_actual< T >::value > = 0>
Self & set (const T &value)
 
template<typename T , typename A = actual_type_t<T>, if_not_t< is_callable< T >::value||is_actual< T >::value > = 0>
Self & set (A &&value)
 
template<typename T , typename A = actual_type_t<T>, if_not_t< is_callable< T >::value||is_actual< T >::value > = 0>
Self & set (const A &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>
Self & set (A &&value)
 Set a pair for an entity.
 
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>
Self & set (const A &value)
 Set a pair for an entity.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & set (Second second, const First &value)
 Set a pair for an entity.
 
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & set (Second second, First &&value)
 Set a pair for an entity.
 
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & set (Second constant, const First &value)
 Set a pair for an entity.
 
template<typename Second >
Self & set_second (entity_t first, const Second &value)
 Set a pair for an entity.
 
template<typename Second >
Self & set_second (entity_t first, Second &&value)
 Set a pair for an entity.
 
template<typename First , typename Second >
Self & set_second (const Second &value)
 
template<typename Func , if_t< is_callable< Func >::value > = 0>
Self & set (const Func &func)
 Set 1..N components.
 
template<typename T , typename ... Args, typename A = actual_type_t<T>>
Self & emplace (Args &&... args)
 Emplace component.
 
template<typename First , typename Second , typename ... Args, typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
Self & emplace (Args &&... args)
 
template<typename First , typename ... Args>
Self & emplace_first (flecs::entity_t second, Args &&... args)
 
template<typename Second , typename ... Args>
Self & emplace_second (flecs::entity_t first, Args &&... args)
 
template<typename Func >
Self & with (const Func &func)
 Entities created in function will have the current entity.
 
template<typename First , typename Func >
Self & with (const Func &func)
 Entities created in function will have (First, this).
 
template<typename Func >
Self & with (entity_t first, const Func &func)
 Entities created in function will have (first, this).
 
template<typename Func >
Self & scope (const Func &func)
 The function will be ran with the scope set to the current entity.
 
scoped_world scope () const
 Return world scoped to entity.
 
Self & set_name (const char *name)
 
Self & set_alias (const char *name)
 
Self & set_doc_name (const char *name)
 Set human readable name.
 
Self & set_doc_brief (const char *brief)
 Set brief description.
 
Self & set_doc_detail (const char *detail)
 Set detailed description.
 
Self & set_doc_link (const char *link)
 Set link to external documentation.
 
Self & set_doc_color (const char *link)
 Set doc color.
 
template<typename Func >
Self & observe (flecs::entity_t evt, Func &&callback)
 Observe event on entity.
 
template<typename Evt , typename Func >
Self & observe (Func &&callback)
 Observe event on entity.
 
template<typename Func >
Self & observe (Func &&callback)
 Observe event on entity.
 
Self & set_json (flecs::id_t e, const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set component from JSON.
 
Self & set_json (flecs::entity_t r, flecs::entity_t t, const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set pair from JSON.
 
template<typename T >
Self & set_json (const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set component from JSON.
 
template<typename R , typename T >
Self & set_json (const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set pair from JSON.
 
template<typename R >
Self & set_json (flecs::entity_t t, const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set pair from JSON.
 
template<typename T >
Self & set_json_second (flecs::entity_t r, const char *json, flecs::from_json_desc_t *desc=nullptr)
 Set pair from JSON.
 
 entity_view ()
 
 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.
 
- Public Member Functions inherited from flecs::entity_view
 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
 
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 parent.
 
bool enabled () const
 
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 entity.
 
template<typename Rel , typename Func >
void children (Func &&func) const
 Iterate children for entity.
 
template<typename Func >
void children (Func &&func) const
 Iterate children for entity.
 
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 > = 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 T , if_t< is_enum< T >::value > = 0>
const T * get () const
 Get enum constant.
 
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 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
 
template<typename First , typename Second >
flecs::entity target_for (flecs::entity_t relationship) const
 
int32_t depth (flecs::entity_t rel) const
 Get depth for given relationship.
 
template<typename Rel >
int32_t depth () const
 Get depth for 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 > = 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.
 
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
 
flecs::entity mut (const flecs::world &stage) const
 Return mutable entity handle for current stage When an entity handle created from the world is used while the world is in staged mode, it will only allow for readonly operations since structural changes are not allowed on the world while in staged mode.
 
flecs::entity mut (const flecs::iter &it) const
 Same as mut(world), but for iterator.
 
flecs::entity mut (const flecs::entity_view &e) const
 Same as mut(world), but for entity.
 
int32_t alert_count (flecs::entity_t alert=0) const
 Return number of alerts for 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.
 
template<typename E >
to_constant () const
 Convert entity to enum constant.
 
void emit (flecs::entity_t evt)
 Emit event for entity.
 
void emit (flecs::entity evt)
 Emit event for entity.
 
template<typename Evt , if_t< is_empty< Evt >::value > = 0>
void emit ()
 Emit event for entity.
 
template<typename Evt , if_not_t< is_empty< Evt >::value > = 0>
void emit (const Evt &payload)
 Emit event with payload for entity.
 
void enqueue (flecs::entity_t evt)
 Enqueue event for entity.
 
void enqueue (flecs::entity evt)
 Enqueue event for entity.
 
template<typename Evt , if_t< is_empty< Evt >::value > = 0>
void enqueue ()
 Enqueue event for entity.
 
template<typename Evt , if_not_t< is_empty< Evt >::value > = 0>
void enqueue (const Evt &payload)
 Enqueue event with payload for entity.
 
flecs::string to_json (const flecs::entity_to_json_desc_t *desc=nullptr) const
 Serialize entity to JSON.
 
Self & unit (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)
 Make entity a unit.
 
- 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::id_t first, flecs::id_t second)
 
 id (const flecs::id &first, const flecs::id &second)
 
bool is_pair () const
 Test if id is pair (has first, second)
 
bool is_wildcard () const
 Test if id is a wildcard.
 
bool is_entity () const
 Test if id is entity.
 
flecs::entity entity () const
 Return id as entity (only allowed when id is valid entity)
 
flecs::entity add_flags (flecs::id_t flags) const
 Return id with role added.
 
flecs::entity remove_flags (flecs::id_t flags) const
 Return id with role removed.
 
flecs::entity remove_flags () const
 Return id without role.
 
flecs::entity remove_generation () const
 Return id without role.
 
flecs::entity type_id () const
 Return component type of id.
 
bool has_flags (flecs::id_t flags) const
 Test if id has specified role.
 
bool has_flags () const
 Test if id has any role.
 
flecs::entity flags () const
 Return id flags set on id.
 
bool has_relation (flecs::id_t first) const
 Test if id has specified first.
 
flecs::entity first () const
 Get first element from a pair.
 
flecs::entity second () const
 Get second element from a pair.
 
flecs::string str () const
 
flecs::string flags_str () const
 Convert role of id to string.
 
flecs::id_t raw_id () const
 Return flecs::id_t value.
 
 operator flecs::id_t () const
 
flecs::world world () const
 

Protected Member Functions

Self & to_base ()
 

Additional Inherited Members

- Protected Attributes inherited from flecs::id
flecs::world_t * m_world
 
flecs::id_t m_id
 

Detailed Description

template<typename Self>
struct flecs::entity_builder< Self >

Entity builder.

Definition at line 15 of file builder.hpp.

Member Function Documentation

◆ add() [1/7]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::add ( )
inline

Add a component to an entity.

To ensure the component is initialized, it should have a constructor.

Template Parameters
Tthe component type to add.

Definition at line 25 of file builder.hpp.

◆ add() [2/7]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::add ( )
inline

Add a pair.

This operation adds a pair to the entity.

Template Parameters
FirstThe first element of the pair
SecondThe second element of the pair

Definition at line 79 of file builder.hpp.

◆ add() [3/7]

template<typename Self >
template<typename E , if_t< is_enum< E >::value > = 0>
Self & flecs::entity_builder< Self >::add ( E value)
inline

Add pair for enum constant.

This operation will add a pair to the entity where the first element is the enumeration type, and the second element the enumeration constant.

The operation may be used with regular (C style) enumerations as well as enum classes.

Parameters
valueThe enumeration value.

Definition at line 42 of file builder.hpp.

◆ add() [4/7]

template<typename Self >
Self & flecs::entity_builder< Self >::add ( entity_t first,
entity_t second )
inline

Add a pair.

This operation adds a pair to the entity.

Parameters
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 67 of file builder.hpp.

◆ add() [5/7]

template<typename Self >
Self & flecs::entity_builder< Self >::add ( id_t component)
inline

Add an entity to an entity.

Add an entity to the entity. This is typically used for tagging.

Parameters
componentThe component to add.

Definition at line 56 of file builder.hpp.

◆ add() [6/7]

template<typename Self >
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::add ( Second constant)
inline

Add a pair.

This operation adds a pair to the entity that consists out of a tag combined with an enum constant.

Template Parameters
FirstThe first element of the pair
Parameters
constantthe enum constant.

Definition at line 104 of file builder.hpp.

◆ add() [7/7]

template<typename Self >
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::add ( Second second)
inline

Add a pair.

This operation adds a pair to the entity.

Template Parameters
FirstThe first element of the pair
Parameters
secondThe second element of the pair.

Definition at line 90 of file builder.hpp.

◆ add_if() [1/6]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::add_if ( bool cond)
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Template Parameters
TThe component to add.
Parameters
condThe condition to evaluate.

Definition at line 143 of file builder.hpp.

◆ add_if() [2/6]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::add_if ( bool cond)
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Template Parameters
FirstThe first element of the pair
SecondThe second element of the pair
Parameters
condThe condition to evaluate.

Definition at line 193 of file builder.hpp.

◆ add_if() [3/6]

template<typename Self >
template<typename E , if_t< is_enum< E >::value > = 0>
Self & flecs::entity_builder< Self >::add_if ( bool cond,
E constant )
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Parameters
condThe condition to evaluate.
constantThe enumeration constant.

Definition at line 204 of file builder.hpp.

◆ add_if() [4/6]

template<typename Self >
Self & flecs::entity_builder< Self >::add_if ( bool cond,
flecs::entity_t first,
flecs::entity_t second )
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Parameters
condThe condition to evaluate.
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 158 of file builder.hpp.

◆ add_if() [5/6]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::add_if ( bool cond,
flecs::entity_t second )
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Template Parameters
FirstThe first element of the pair
Parameters
condThe condition to evaluate.
secondThe second element of the pair.

Definition at line 181 of file builder.hpp.

◆ add_if() [6/6]

template<typename Self >
Self & flecs::entity_builder< Self >::add_if ( bool cond,
flecs::id_t component )
inline

Conditional add.

This operation adds if condition is true, removes if condition is false.

Parameters
condThe condition to evaluate.
componentThe component to add.

Definition at line 128 of file builder.hpp.

◆ add_second()

template<typename Self >
template<typename Second >
Self & flecs::entity_builder< Self >::add_second ( flecs::entity_t first)
inline

Add a pair.

This operation adds a pair to the entity.

Parameters
firstThe first element of the pair
Template Parameters
SecondThe second element of the pair

Definition at line 118 of file builder.hpp.

◆ child_of() [1/2]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::child_of ( )
inline

Shortcut for add(ChildOf, entity).

Template Parameters
Tthe type associated with the entity.

Definition at line 277 of file builder.hpp.

◆ child_of() [2/2]

template<typename Self >
Self & flecs::entity_builder< Self >::child_of ( entity_t second)
inline

Shortcut for add(ChildOf, entity).

Parameters
secondThe second element of the pair.

Definition at line 230 of file builder.hpp.

◆ depends_on() [1/3]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::depends_on ( )
inline

Shortcut for add(DependsOn, entity).

Template Parameters
Tthe type associated with the entity.

Definition at line 286 of file builder.hpp.

◆ depends_on() [2/3]

template<typename Self >
template<typename E , if_t< is_enum< E >::value > = 0>
Self & flecs::entity_builder< Self >::depends_on ( E second)
inline

Shortcut for add(DependsOn, entity).

Parameters
secondThe second element of the pair.

Definition at line 247 of file builder.hpp.

◆ depends_on() [3/3]

template<typename Self >
Self & flecs::entity_builder< Self >::depends_on ( entity_t second)
inline

Shortcut for add(DependsOn, entity).

Parameters
secondThe second element of the pair.

Definition at line 238 of file builder.hpp.

◆ disable() [1/6]

template<typename Self >
Self & flecs::entity_builder< Self >::disable ( )
inline

Disable an entity.

Disabled entities are not matched with systems and cannot be searched with queries, unless explicitly specified in the query expression.

Definition at line 559 of file builder.hpp.

◆ disable() [2/6]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::disable ( )
inline

Disable a component.

See also
disable(flecs::id_t id)
Template Parameters
TThe component to enable.

Definition at line 634 of file builder.hpp.

◆ disable() [3/6]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::disable ( )
inline

Disable a pair.

See also
disable(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair.

Definition at line 666 of file builder.hpp.

◆ disable() [4/6]

template<typename Self >
Self & flecs::entity_builder< Self >::disable ( flecs::id_t first,
flecs::id_t second )
inline

Disable a pair.

See also
disable(flecs::id_t id)
Parameters
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 644 of file builder.hpp.

◆ disable() [5/6]

template<typename Self >
Self & flecs::entity_builder< Self >::disable ( flecs::id_t id)
inline

Disable an id.

This sets the enabled bit for this id. If this is the first time the id is enabled or disabled, the bitset is added.

Parameters
idThe id to disable.

Definition at line 624 of file builder.hpp.

◆ disable() [6/6]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::disable ( flecs::id_t second)
inline

Disable a pair.

See also
disable(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.

Definition at line 655 of file builder.hpp.

◆ emplace() [1/2]

template<typename Self >
template<typename T , typename ... Args, typename A = actual_type_t<T>>
Self & flecs::entity_builder< Self >::emplace ( Args &&... args)
inline

Emplace component.

Emplace constructs a component in the storage, which prevents calling the destructor on the value passed into the function.

Emplace attempts the following signatures to construct the component:

T{Args...}
T{flecs::entity, Args...}
Entity.
Definition entity.hpp:30

If the second signature matches, emplace will pass in the current entity as argument to the constructor, which is useful if the component needs to be aware of the entity to which it has been added.

Emplace may only be called for components that have not yet been added to the entity.

Template Parameters
Tthe component to emplace
Parameters
argsThe arguments to pass to the constructor of T

Definition at line 868 of file builder.hpp.

◆ emplace() [2/2]

template<typename Self >
template<typename First , typename Second , typename ... Args, typename P = pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
Self & flecs::entity_builder< Self >::emplace ( Args &&... args)
inline

Definition at line 876 of file builder.hpp.

◆ emplace_first()

template<typename Self >
template<typename First , typename ... Args>
Self & flecs::entity_builder< Self >::emplace_first ( flecs::entity_t second,
Args &&... args )
inline

Definition at line 885 of file builder.hpp.

◆ emplace_override() [1/2]

template<typename Self >
template<typename T , typename ... Args>
Self & flecs::entity_builder< Self >::emplace_override ( Args &&... args)
inline

Emplace component, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
TThe component to emplace and override.

Definition at line 517 of file builder.hpp.

◆ emplace_override() [2/2]

template<typename Self >
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, typename ... Args>
Self & flecs::entity_builder< Self >::emplace_override ( Args &&... args)
inline

Emplace pair, mark pair for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair to emplace and override.
SecondThe second element of the pair to emplace and override.

Definition at line 535 of file builder.hpp.

◆ emplace_second()

template<typename Self >
template<typename Second , typename ... Args>
Self & flecs::entity_builder< Self >::emplace_second ( flecs::entity_t first,
Args &&... args )
inline

Definition at line 893 of file builder.hpp.

◆ enable() [1/6]

template<typename Self >
Self & flecs::entity_builder< Self >::enable ( )
inline

Enable an entity.

Enabled entities are matched with systems and can be searched with queries.

Definition at line 550 of file builder.hpp.

◆ enable() [2/6]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::enable ( )
inline

Enable a component.

See also
enable(flecs::id_t id)
Template Parameters
TThe component to enable.

Definition at line 582 of file builder.hpp.

◆ enable() [3/6]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::enable ( )
inline

Enable a pair.

See also
enable(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair.

Definition at line 614 of file builder.hpp.

◆ enable() [4/6]

template<typename Self >
Self & flecs::entity_builder< Self >::enable ( flecs::id_t first,
flecs::id_t second )
inline

Enable a pair.

See also
enable(flecs::id_t id)
Parameters
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 592 of file builder.hpp.

◆ enable() [5/6]

template<typename Self >
Self & flecs::entity_builder< Self >::enable ( flecs::id_t id,
bool toggle = true )
inline

Enable an id.

This sets the enabled bit for this component. If this is the first time the component is enabled or disabled, the bitset is added.

Parameters
idThe id to enable.
toggleTrue to enable, false to disable (default = true).

Definition at line 571 of file builder.hpp.

◆ enable() [6/6]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::enable ( flecs::id_t second)
inline

Enable a pair.

See also
enable(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.

Definition at line 603 of file builder.hpp.

◆ entity_view() [1/3]

template<typename Self >
flecs::entity_view::entity_view ( )
inline

Definition at line 30 of file entity_view.hpp.

◆ entity_view() [2/3]

template<typename Self >
flecs::entity_view::entity_view ( entity_t id)
inline

Implicit conversion from flecs::entity_t to flecs::entity_view.

Definition at line 44 of file entity_view.hpp.

◆ entity_view() [3/3]

template<typename Self >
flecs::entity_view::entity_view ( flecs::world_t * world,
flecs::id_t id )
inlineexplicit

Wrap an existing entity id.

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

Definition at line 37 of file entity_view.hpp.

◆ is_a() [1/2]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::is_a ( )
inline

Shortcut for add(IsA, entity).

Template Parameters
Tthe type associated with the entity.

Definition at line 222 of file builder.hpp.

◆ is_a() [2/2]

template<typename Self >
Self & flecs::entity_builder< Self >::is_a ( entity_t second)
inline

Shortcut for add(IsA, entity).

Parameters
secondThe second element of the pair.

Definition at line 213 of file builder.hpp.

◆ observe() [1/3]

template<typename Self >
template<typename Func >
Self & flecs::entity_builder< Self >::observe ( flecs::entity_t evt,
Func && callback )
inline

Observe event on entity.

Parameters
evtThe event id.
callbackThe observer callback.
Returns
Event builder.

Definition at line 75 of file impl.hpp.

◆ observe() [2/3]

template<typename Self >
template<typename Evt , typename Func >
Self & flecs::entity_builder< Self >::observe ( Func && callback)
inline

Observe event on entity.

Template Parameters
EvtThe event type.
Parameters
callbackThe observer callback.
Returns
Event builder.

Definition at line 87 of file impl.hpp.

◆ observe() [3/3]

template<typename Self >
template<typename Func >
Self & flecs::entity_builder< Self >::observe ( Func && callback)
inline

Observe event on entity.

Parameters
callbackThe observer callback.
Returns
Event builder.

Definition at line 95 of file impl.hpp.

◆ override() [1/5]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::override ( )
inline

Mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
TThe component to mark for overriding.

Definition at line 413 of file builder.hpp.

◆ override() [2/5]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::override ( )
inline

Mark pair for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair.

Definition at line 435 of file builder.hpp.

◆ override() [3/5]

template<typename Self >
Self & flecs::entity_builder< Self >::override ( flecs::entity_t first,
flecs::entity_t second )
inline

Mark pair for auto-overriding.

See also
override(flecs::id_t id)
Parameters
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 403 of file builder.hpp.

◆ override() [4/5]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::override ( flecs::entity_t second)
inline

Mark pair for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.

Definition at line 424 of file builder.hpp.

◆ override() [5/5]

template<typename Self >
Self & flecs::entity_builder< Self >::override ( flecs::id_t id)
inline

Mark id for auto-overriding.

When an entity inherits from a base entity (using the IsA relationship) any ids marked for auto-overriding on the base will be overridden automatically by the entity.

Parameters
idThe id to mark for overriding.

Definition at line 393 of file builder.hpp.

◆ remove() [1/7]

template<typename Self >
template<typename T , if_not_t< is_enum< T >::value > = 0>
Self & flecs::entity_builder< Self >::remove ( )
inline

Remove a component from an entity.

Template Parameters
Tthe type of the component to remove.

Definition at line 304 of file builder.hpp.

◆ remove() [2/7]

template<typename Self >
template<typename E , if_t< is_enum< E >::value > = 0>
Self & flecs::entity_builder< Self >::remove ( )
inline

Remove pair for enum.

This operation will remove any (Enum, *) pair from the entity.

Template Parameters
EThe enumeration type.

Definition at line 315 of file builder.hpp.

◆ remove() [3/7]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::remove ( )
inline

Removes a pair.

This operation removes a pair from the entity.

Template Parameters
FirstThe first element of the pair
SecondThe second element of the pair

Definition at line 347 of file builder.hpp.

◆ remove() [4/7]

template<typename Self >
Self & flecs::entity_builder< Self >::remove ( entity_t entity)
inline

Remove an entity from an entity.

Parameters
entityThe entity to remove.

Definition at line 324 of file builder.hpp.

◆ remove() [5/7]

template<typename Self >
Self & flecs::entity_builder< Self >::remove ( entity_t first,
entity_t second )
inline

Remove a pair.

This operation removes a pair from the entity.

Parameters
firstThe first element of the pair.
secondThe second element of the pair.

Definition at line 335 of file builder.hpp.

◆ remove() [6/7]

template<typename Self >
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::remove ( Second constant)
inline

Remove a pair.

This operation removes the pair from the entity.

Template Parameters
FirstThe first element of the pair
Parameters
constantthe enum constant.

Definition at line 380 of file builder.hpp.

◆ remove() [7/7]

template<typename Self >
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::remove ( Second second)
inline

Remove a pair.

This operation removes the pair from the entity.

Template Parameters
FirstThe first element of the pair
Parameters
secondThe second element of the pair.

Definition at line 358 of file builder.hpp.

◆ remove_second()

template<typename Self >
template<typename Second >
Self & flecs::entity_builder< Self >::remove_second ( flecs::entity_t first)
inline

Removes a pair.

This operation removes a pair from the entity.

Template Parameters
SecondThe second element of the pair
Parameters
firstThe first element of the pair

Definition at line 369 of file builder.hpp.

◆ scope() [1/2]

template<typename Self >
scoped_world flecs::entity_builder< Self >::scope ( ) const
inline

Return world scoped to entity.

Definition at line 950 of file builder.hpp.

◆ scope() [2/2]

template<typename Self >
template<typename Func >
Self & flecs::entity_builder< Self >::scope ( const Func & func)
inline

The function will be ran with the scope set to the current entity.

Definition at line 942 of file builder.hpp.

◆ set() [1/10]

template<typename Self >
template<typename T , typename A = actual_type_t<T>, if_not_t< is_callable< T >::value||is_actual< T >::value > = 0>
Self & flecs::entity_builder< Self >::set ( A && value)
inline

Definition at line 701 of file builder.hpp.

◆ set() [2/10]

template<typename Self >
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>
Self & flecs::entity_builder< Self >::set ( A && value)
inline

Set a pair for an entity.

This operation sets the pair value, and uses First as type. If the entity did not yet have the pair, it will be added.

Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair
Parameters
valueThe value to set.

Definition at line 723 of file builder.hpp.

◆ set() [3/10]

template<typename Self >
template<typename T , typename A = actual_type_t<T>, if_not_t< is_callable< T >::value||is_actual< T >::value > = 0>
Self & flecs::entity_builder< Self >::set ( const A & value)
inline

Definition at line 708 of file builder.hpp.

◆ set() [4/10]

template<typename Self >
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>
Self & flecs::entity_builder< Self >::set ( const A & value)
inline

Set a pair for an entity.

This operation sets the pair value, and uses First as type. If the entity did not yet have the pair, it will be added.

Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair
Parameters
valueThe value to set.

Definition at line 738 of file builder.hpp.

◆ set() [5/10]

template<typename Self >
template<typename Func , if_t< is_callable< Func >::value > >
Self & flecs::entity_builder< Self >::set ( const Func & func)
inline

Set 1..N components.

This operation accepts a callback with as arguments the components to set. If the entity does not have all of the provided components, they will be added.

This operation is faster than individually calling get for each component as it only obtains entity metadata once. When this operation is called while deferred, its performance is equivalent to that of calling get_mut for each component separately.

The operation will invoke modified for each component after the callback has been invoked.

Parameters
funcThe callback to invoke.

Definition at line 17 of file impl.hpp.

◆ set() [6/10]

template<typename Self >
template<typename T , if_t< !is_callable< T >::value &&is_actual< T >::value > = 0>
Self & flecs::entity_builder< Self >::set ( const T & value)
inline

Definition at line 694 of file builder.hpp.

◆ set() [7/10]

template<typename Self >
template<typename First , typename Second , if_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::set ( Second constant,
const First & value )
inline

Set a pair for an entity.

This operation sets the pair value, and uses First as type. If the entity did not yet have the pair, it will be added.

Template Parameters
FirstThe first element of the pair.
Parameters
constantThe enum constant.
valueThe value to set.

Definition at line 784 of file builder.hpp.

◆ set() [8/10]

template<typename Self >
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::set ( Second second,
const First & value )
inline

Set a pair for an entity.

This operation sets the pair value, and uses First as type. If the entity did not yet have the pair, it will be added.

Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.
valueThe value to set.

Definition at line 752 of file builder.hpp.

◆ set() [9/10]

template<typename Self >
template<typename First , typename Second , if_not_t< is_enum< Second >::value > = 0>
Self & flecs::entity_builder< Self >::set ( Second second,
First && value )
inline

Set a pair for an entity.

This operation sets the pair value, and uses First as type. If the entity did not yet have the pair, it will be added.

Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.
valueThe value to set.

Definition at line 768 of file builder.hpp.

◆ set() [10/10]

template<typename Self >
template<typename T , if_t< !is_callable< T >::value &&is_actual< T >::value > = 0>
Self & flecs::entity_builder< Self >::set ( T && value)
inline

Definition at line 687 of file builder.hpp.

◆ set_alias()

template<typename Self >
Self & flecs::entity_builder< Self >::set_alias ( const char * name)
inline

Definition at line 963 of file builder.hpp.

◆ set_name()

template<typename Self >
Self & flecs::entity_builder< Self >::set_name ( const char * name)
inline

Definition at line 956 of file builder.hpp.

◆ set_override() [1/6]

template<typename Self >
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>
Self & flecs::entity_builder< Self >::set_override ( A && val)
inline

Set component, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair.

Definition at line 506 of file builder.hpp.

◆ set_override() [2/6]

template<typename Self >
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>
Self & flecs::entity_builder< Self >::set_override ( const A & val)
inline

Set component, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
SecondThe second element of the pair.

Definition at line 493 of file builder.hpp.

◆ set_override() [3/6]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::set_override ( const T & val)
inline

Set component, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
TThe component to set and for which to add the OVERRIDE flag

Definition at line 445 of file builder.hpp.

◆ set_override() [4/6]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::set_override ( flecs::entity_t second,
const First & val )
inline

Set pair, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.

Definition at line 468 of file builder.hpp.

◆ set_override() [5/6]

template<typename Self >
template<typename First >
Self & flecs::entity_builder< Self >::set_override ( flecs::entity_t second,
First && val )
inline

Set pair, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
FirstThe first element of the pair.
Parameters
secondThe second element of the pair.

Definition at line 480 of file builder.hpp.

◆ set_override() [6/6]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::set_override ( T && val)
inline

Set component, mark component for auto-overriding.

See also
override(flecs::id_t id)
Template Parameters
TThe component to set and for which to add the OVERRIDE flag

Definition at line 456 of file builder.hpp.

◆ set_ptr() [1/2]

template<typename Self >
Self & flecs::entity_builder< Self >::set_ptr ( entity_t comp,
const void * ptr )
inline

Definition at line 675 of file builder.hpp.

◆ set_ptr() [2/2]

template<typename Self >
Self & flecs::entity_builder< Self >::set_ptr ( entity_t comp,
size_t size,
const void * ptr )
inline

Definition at line 670 of file builder.hpp.

◆ set_second() [1/3]

template<typename Self >
template<typename First , typename Second >
Self & flecs::entity_builder< Self >::set_second ( const Second & value)
inline

Definition at line 823 of file builder.hpp.

◆ set_second() [2/3]

template<typename Self >
template<typename Second >
Self & flecs::entity_builder< Self >::set_second ( entity_t first,
const Second & value )
inline

Set a pair for an entity.

This operation sets the pair value, and uses Second as type. If the entity did not yet have the pair, it will be added.

Template Parameters
SecondThe second element of the pair
Parameters
firstThe first element of the pair.
valueThe value to set.

Definition at line 799 of file builder.hpp.

◆ set_second() [3/3]

template<typename Self >
template<typename Second >
Self & flecs::entity_builder< Self >::set_second ( entity_t first,
Second && value )
inline

Set a pair for an entity.

This operation sets the pair value, and uses Second as type. If the entity did not yet have the pair, it will be added.

Template Parameters
SecondThe second element of the pair
Parameters
firstThe first element of the pair.
valueThe value to set.

Definition at line 815 of file builder.hpp.

◆ slot()

template<typename Self >
Self & flecs::entity_builder< Self >::slot ( )
inline

Shortcut for add(SlotOf, target(ChildOf)).

Definition at line 264 of file builder.hpp.

◆ slot_of() [1/2]

template<typename Self >
template<typename T >
Self & flecs::entity_builder< Self >::slot_of ( )
inline

Shortcut for add(SlotOf, entity).

Template Parameters
Tthe type associated with the entity.

Definition at line 295 of file builder.hpp.

◆ slot_of() [2/2]

template<typename Self >
Self & flecs::entity_builder< Self >::slot_of ( entity_t second)
inline

Shortcut for add(SlotOf, entity).

Parameters
secondThe second element of the pair.

Definition at line 258 of file builder.hpp.

◆ to_base()

template<typename Self >
Self & flecs::entity_builder< Self >::to_base ( )
inlineprotected

Definition at line 983 of file builder.hpp.

◆ with() [1/3]

template<typename Self >
template<typename Func >
Self & flecs::entity_builder< Self >::with ( const Func & func)
inline

Entities created in function will have the current entity.

This operation is thread safe.

Parameters
funcThe function to call.

Definition at line 906 of file builder.hpp.

◆ with() [2/3]

template<typename Self >
template<typename First , typename Func >
Self & flecs::entity_builder< Self >::with ( const Func & func)
inline

Entities created in function will have (First, this).

This operation is thread safe.

Template Parameters
FirstThe first element of the pair
Parameters
funcThe function to call.

Definition at line 920 of file builder.hpp.

◆ with() [3/3]

template<typename Self >
template<typename Func >
Self & flecs::entity_builder< Self >::with ( entity_t first,
const Func & func )
inline

Entities created in function will have (first, this).

This operation is thread safe.

Parameters
firstThe first element of the pair.
funcThe function to call.

Definition at line 932 of file builder.hpp.


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