![]() |
Flecs v3.2
A fast entity component system (ECS) for C & C++
|
Entity builder. More...
#include <builder.hpp>
Public Member Functions | |
template<typename T > | |
Self & | add () |
Add a component to an entity. | |
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). | |
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. | |
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. | |
template<typename E , if_t< is_enum< E >::value > = 0> | |
Self & | add (E value) |
Add pair for enum constant. | |
template<typename E , if_t< is_enum< E >::value > = 0> | |
Self & | remove () |
Remove pair for enum. | |
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 doc name. | |
Self & | set_doc_brief (const char *brief) |
Set doc brief. | |
Self & | set_doc_detail (const char *detail) |
Set doc detailed description. | |
Self & | set_doc_link (const char *link) |
Set doc link. | |
Self & | set_doc_color (const char *link) |
Set doc color. | |
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_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 is entity is valid. | |
operator bool () const | |
bool | is_alive () const |
Check is 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) 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. | |
template<typename E > | |
E | to_constant () const |
Convert entity to enum constant. | |
flecs::string | to_json (const flecs::entity_to_json_desc_t *desc=nullptr) |
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. | |
![]() | |
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 | |
![]() | |
flecs::world_t * | m_world |
flecs::id_t | m_id |
![]() | |
Self & | unit (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 derived unit. | |
Self & | unit_prefix (const char *symbol, int32_t factor=0, int32_t power=0) |
Make entity a derived unit. | |
Self & | quantity (flecs::entity_t quantity) |
Add quantity to unit. | |
template<typename Quantity > | |
Self & | quantity () |
Make entity a unity prefix. | |
Self & | quantity () |
Make entity a quantity. | |
Entity builder.
Definition at line 15 of file builder.hpp.
Add a component to an entity.
To ensure the component is initialized, it should have a constructor.
T | the component type to add. |
Definition at line 25 of file builder.hpp.
|
inline |
Add a pair.
This operation adds a pair to the entity.
First | The first element of the pair |
Second | The second element of the pair |
Definition at line 60 of file builder.hpp.
|
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.
value | The enumeration value. |
Definition at line 514 of file builder.hpp.
|
inline |
Add a pair.
This operation adds a pair to the entity.
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 48 of file builder.hpp.
|
inline |
Add an entity to an entity.
Add an entity to the entity. This is typically used for tagging.
component | The component to add. |
Definition at line 37 of file builder.hpp.
|
inline |
Add a pair.
This operation adds a pair to the entity that consists out of a tag combined with an enum constant.
First | The first element of the pair |
constant | the enum constant. |
Definition at line 85 of file builder.hpp.
|
inline |
Add a pair.
This operation adds a pair to the entity.
First | The first element of the pair |
second | The second element of the pair. |
Definition at line 71 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
T | The component to add. |
cond | The condition to evaluate. |
Definition at line 124 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
First | The first element of the pair |
Second | The second element of the pair |
cond | The condition to evaluate. |
Definition at line 174 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
cond | The condition to evaluate. |
constant | The enumeration constant. |
Definition at line 185 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
cond | The condition to evaluate. |
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 139 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
First | The first element of the pair |
cond | The condition to evaluate. |
second | The second element of the pair. |
Definition at line 162 of file builder.hpp.
|
inline |
Conditional add.
This operation adds if condition is true, removes if condition is false.
cond | The condition to evaluate. |
component | The component to add. |
Definition at line 109 of file builder.hpp.
|
inline |
Add a pair.
This operation adds a pair to the entity.
first | The first element of the pair |
Second | The second element of the pair |
Definition at line 99 of file builder.hpp.
|
inline |
Shortcut for add(ChildOf, entity).
T | the type associated with the entity. |
Definition at line 246 of file builder.hpp.
|
inline |
Shortcut for add(ChildOf, entity).
second | The second element of the pair. |
Definition at line 211 of file builder.hpp.
|
inline |
Shortcut for add(DependsOn, entity).
T | the type associated with the entity. |
Definition at line 255 of file builder.hpp.
|
inline |
Shortcut for add(DependsOn, entity).
second | The second element of the pair. |
Definition at line 219 of file builder.hpp.
|
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 545 of file builder.hpp.
|
inline |
Disable a component.
T | The component to enable. |
Definition at line 620 of file builder.hpp.
|
inline |
Disable a pair.
First | The first element of the pair. |
Second | The second element of the pair. |
Definition at line 652 of file builder.hpp.
|
inline |
Disable a pair.
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 630 of file builder.hpp.
|
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.
id | The id to disable. |
Definition at line 610 of file builder.hpp.
|
inline |
Disable a pair.
First | The first element of the pair. |
second | The second element of the pair. |
Definition at line 641 of file builder.hpp.
|
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...}
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.
T | the component to emplace |
args | The arguments to pass to the constructor of T |
Definition at line 851 of file builder.hpp.
|
inline |
Definition at line 859 of file builder.hpp.
|
inline |
Definition at line 868 of file builder.hpp.
|
inline |
Emplace component, mark component for auto-overriding.
T | The component to emplace and override. |
Definition at line 475 of file builder.hpp.
|
inline |
Emplace pair, mark pair for auto-overriding.
First | The first element of the pair to emplace and override. |
Second | The second element of the pair to emplace and override. |
Definition at line 493 of file builder.hpp.
|
inline |
Definition at line 876 of file builder.hpp.
|
inline |
Enable an entity.
Enabled entities are matched with systems and can be searched with queries.
Definition at line 536 of file builder.hpp.
|
inline |
Enable a component.
T | The component to enable. |
Definition at line 568 of file builder.hpp.
|
inline |
Enable a pair.
First | The first element of the pair. |
Second | The second element of the pair. |
Definition at line 600 of file builder.hpp.
|
inline |
Enable a pair.
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 578 of file builder.hpp.
|
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.
id | The id to enable. |
toggle | True to enable, false to disable (default = true). |
Definition at line 557 of file builder.hpp.
|
inline |
Enable a pair.
First | The first element of the pair. |
second | The second element of the pair. |
Definition at line 589 of file builder.hpp.
|
inline |
Definition at line 30 of file entity_view.hpp.
|
inline |
Implicit conversion from flecs::entity_t to flecs::entity_view.
Definition at line 44 of file entity_view.hpp.
|
inlineexplicit |
Wrap an existing entity id.
world | The world in which the entity is created. |
id | The entity id. |
Definition at line 37 of file entity_view.hpp.
|
inline |
Shortcut for add(IsA, entity).
T | the type associated with the entity. |
Definition at line 203 of file builder.hpp.
|
inline |
Shortcut for add(IsA, entity).
second | The second element of the pair. |
Definition at line 194 of file builder.hpp.
|
inline |
Mark component for auto-overriding.
T | The component to mark for overriding. |
Definition at line 371 of file builder.hpp.
|
inline |
Mark pair for auto-overriding.
First | The first element of the pair. |
Second | The second element of the pair. |
Definition at line 393 of file builder.hpp.
|
inline |
Mark pair for auto-overriding.
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 361 of file builder.hpp.
|
inline |
Mark pair for auto-overriding.
First | The first element of the pair. |
second | The second element of the pair. |
Definition at line 382 of file builder.hpp.
|
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.
id | The id to mark for overriding. |
Definition at line 351 of file builder.hpp.
|
inline |
Remove a component from an entity.
T | the type of the component to remove. |
Definition at line 273 of file builder.hpp.
|
inline |
Removes a pair.
This operation removes a pair from the entity.
First | The first element of the pair |
Second | The second element of the pair |
Definition at line 305 of file builder.hpp.
|
inline |
Remove pair for enum.
This operation will remove any (Enum, *) pair from the entity.
E | The enumeration type. |
Definition at line 527 of file builder.hpp.
|
inline |
Remove an entity from an entity.
entity | The entity to remove. |
Definition at line 282 of file builder.hpp.
|
inline |
Remove a pair.
This operation removes a pair from the entity.
first | The first element of the pair. |
second | The second element of the pair. |
Definition at line 293 of file builder.hpp.
|
inline |
Remove a pair.
This operation adds a pair to the entity.
First | The first element of the pair |
constant | the enum constant. |
Definition at line 338 of file builder.hpp.
|
inline |
Remove a pair.
This operation adds a pair to the entity.
First | The first element of the pair |
second | The second element of the pair. |
Definition at line 316 of file builder.hpp.
|
inline |
Removes a pair.
This operation removes a pair from the entity.
Second | The second element of the pair |
first | The first element of the pair |
Definition at line 327 of file builder.hpp.
|
inline |
Return world scoped to entity.
Definition at line 931 of file builder.hpp.
|
inline |
The function will be ran with the scope set to the current entity.
Definition at line 923 of file builder.hpp.
|
inline |
Definition at line 687 of file builder.hpp.
|
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.
First | The first element of the pair. |
Second | The second element of the pair |
value | The value to set. |
Definition at line 709 of file builder.hpp.
|
inline |
Definition at line 694 of file builder.hpp.
|
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.
First | The first element of the pair. |
Second | The second element of the pair |
value | The value to set. |
Definition at line 724 of file builder.hpp.
|
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.
func | The callback to invoke. |
|
inline |
Definition at line 680 of file builder.hpp.
|
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.
First | The first element of the pair. |
constant | The enum constant. |
value | The value to set. |
Definition at line 770 of file builder.hpp.
|
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.
First | The first element of the pair. |
second | The second element of the pair. |
value | The value to set. |
Definition at line 738 of file builder.hpp.
|
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.
First | The first element of the pair. |
second | The second element of the pair. |
value | The value to set. |
Definition at line 754 of file builder.hpp.
|
inline |
Definition at line 673 of file builder.hpp.
|
inline |
Definition at line 944 of file builder.hpp.
|
inline |
Definition at line 937 of file builder.hpp.
|
inline |
Set component, mark component for auto-overriding.
First | The first element of the pair. |
Second | The second element of the pair. |
Definition at line 464 of file builder.hpp.
|
inline |
Set component, mark component for auto-overriding.
First | The first element of the pair. |
Second | The second element of the pair. |
Definition at line 451 of file builder.hpp.
|
inline |
Set component, mark component for auto-overriding.
T | The component to set and for which to add the OVERRIDE flag |
Definition at line 403 of file builder.hpp.
|
inline |
Set pair, mark component for auto-overriding.
First | The first element of the pair. |
second | The second element of the pair. |
Definition at line 426 of file builder.hpp.
|
inline |
Set pair, mark component for auto-overriding.
First | The first element of the pair. |
second | The second element of the pair. |
Definition at line 438 of file builder.hpp.
|
inline |
Set component, mark component for auto-overriding.
T | The component to set and for which to add the OVERRIDE flag |
Definition at line 414 of file builder.hpp.
|
inline |
Definition at line 661 of file builder.hpp.
|
inline |
Definition at line 656 of file builder.hpp.
|
inline |
Definition at line 809 of file builder.hpp.
|
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.
Second | The second element of the pair |
first | The first element of the pair. |
value | The value to set. |
Definition at line 785 of file builder.hpp.
|
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.
Second | The second element of the pair |
first | The first element of the pair. |
value | The value to set. |
Definition at line 801 of file builder.hpp.
|
inline |
Shortcut for add(SlotOf, target(ChildOf)).
Definition at line 233 of file builder.hpp.
|
inline |
Shortcut for add(SlotOf, entity).
T | the type associated with the entity. |
Definition at line 264 of file builder.hpp.
|
inline |
Shortcut for add(SlotOf, entity).
second | The second element of the pair. |
Definition at line 227 of file builder.hpp.
|
inlineprotected |
Definition at line 958 of file builder.hpp.
|
inline |
Entities created in function will have the current entity.
func | The function to call. |
Definition at line 888 of file builder.hpp.
|
inline |
Entities created in function will have (First, this).
This operation is thread safe.
First | The first element of the pair |
func | The function to call. |
Definition at line 902 of file builder.hpp.
|
inline |
Entities created in function will have (first, this).
first | The first element of the pair. |
func | The function to call. |
Definition at line 913 of file builder.hpp.