gaia::ecs::World::EntityBuilder Struct Reference

Public Member Functions
	EntityBuilder (World &world, Entity entity, EntityContainer &ec)
	EntityBuilder (World &world, Entity entity)
	EntityBuilder (const EntityBuilder &)=default
	EntityBuilder (EntityBuilder &&)=delete
EntityBuilder &	operator= (const EntityBuilder &)=delete
EntityBuilder &	operator= (EntityBuilder &&)=delete
void	commit ()
	Commits all gathered changes and performs an archetype movement.
void	name (const char *name, uint32_t len=0)
	Assigns a name to entity. Ignored if used with pair. The string is copied and kept internally.
void	name_raw (const char *name, uint32_t len=0)
	Assigns a name to entity. Ignored if used with pair. The string is NOT copied. Your are responsible for its lifetime.
void	alias (const char *alias, uint32_t len=0)
	Assigns an alias to entity. Ignored if used with pair. The string is copied and kept internally.
void	alias_raw (const char *alias, uint32_t len=0)
	Assigns an alias to entity. Ignored if used with pair. The string is NOT copied. You are responsible for its lifetime.
void	del_name ()
	Removes any name associated with the entity.
void	del_alias ()
	Removes any alias associated with the entity.
EntityBuilder &	add (Entity entity)
	Prepares an archetype movement by following the "add" edge of the current archetype.
EntityBuilder &	add (Pair pair)
	Prepares an archetype movement by following the "add" edge of the current archetype.
EntityBuilder &	as (Entity entityBase)
	Shortcut for add(Pair(Is, entityBase)). Effectively makes an entity inherit from entityBase.
EntityBuilder &	prefab ()
	Marks the entity as a prefab.
GAIA_NODISCARD bool	as (Entity entity, Entity entityBase) const
	Check if entity inherits from entityBase.
EntityBuilder &	child (Entity parent)
	Shortcut for add(Pair(ChildOf, parent))
template<typename T >
Entity	register_component ()
	Takes care of registering the component.
template<typename T >
EntityBuilder &	add ()
EntityBuilder &	del (Entity entity)
	Prepares an archetype movement by following the "del" edge of the current archetype.
EntityBuilder &	del (Pair pair)
	Prepares an archetype movement by following the "del" edge of the current archetype.
template<typename T >
EntityBuilder &	del ()

Public Attributes
World &	m_world
Archetype *	m_pArchetypeSrc = nullptr
	Original archetype m_entity belongs to.
Chunk *	m_pChunkSrc = nullptr
	Original chunk m_entity belonged to.
uint32_t	m_rowSrc = 0
	Original row.
Archetype *	m_pArchetype = nullptr
	Target archetype we want to move to.
EntityNameLookupKey	m_targetNameKey
	Target name.
EntityNameLookupKey	m_targetAliasKey
	Target alias string pointer.
Entity	m_entity
	Source entity.
Entity	m_graphEdgeEntity = EntityBad
	Entity describing a single-step graph transition recorded during builder use.
uint8_t	m_graphEdgeOpCount = 0
	Number of archetype-changing builder operations since the last commit.
bool	m_graphEdgeIsAdd = false
	Whether the recorded single-step transition is an add or delete move.

Friends
class	World

Member Function Documentation

add() [1/2]

EntityBuilder & gaia::ecs::World::EntityBuilder::add ( Entity  entity )

inline

Prepares an archetype movement by following the "add" edge of the current archetype.

Parameters

entity

Added entity

add() [2/2]

EntityBuilder & gaia::ecs::World::EntityBuilder::add ( Pair  pair )

inline

Prepares an archetype movement by following the "add" edge of the current archetype.

Parameters

pair	Relationship pair

alias()

void gaia::ecs::World::EntityBuilder::alias ( const char *  alias, uint32_t  len = 0  )

inline

Assigns an alias to entity. Ignored if used with pair. The string is copied and kept internally.

Parameters

alias	A null-terminated string.
len	String length. If zero, the length is calculated.

alias_raw()

void gaia::ecs::World::EntityBuilder::alias_raw ( const char *  alias, uint32_t  len = 0  )

inline

Assigns an alias to entity. Ignored if used with pair. The string is NOT copied. You are responsible for its lifetime.

Parameters

alias	Pointer to a stable null-terminated string.
len	String length. If zero, the length is calculated.

as() [1/2]

GAIA_NODISCARD bool gaia::ecs::World::EntityBuilder::as ( Entity  entity, Entity  entityBase  ) const

inline

Check if entity inherits from entityBase.

Parameters

entity	Source entity
entityBase	Base entity

Returns

True if entity inherits from entityBase

as() [2/2]

EntityBuilder & gaia::ecs::World::EntityBuilder::as ( Entity  entityBase )

inline

Shortcut for add(Pair(Is, entityBase)). Effectively makes an entity inherit from entityBase.

Parameters

entityBase

Entity to inherit from

commit()

void gaia::ecs::World::EntityBuilder::commit ( )

inline

Commits all gathered changes and performs an archetype movement.

Warning

Once called, the object is returned to its default state (as if no add/remove was ever called).

del() [1/2]

EntityBuilder & gaia::ecs::World::EntityBuilder::del ( Entity  entity )

inline

Prepares an archetype movement by following the "del" edge of the current archetype.

Parameters

entity

Removed entity

del() [2/2]

EntityBuilder & gaia::ecs::World::EntityBuilder::del ( Pair  pair )

inline

Prepares an archetype movement by following the "del" edge of the current archetype.

Parameters

pair	Relationship pair

name()

void gaia::ecs::World::EntityBuilder::name ( const char *  name, uint32_t  len = 0  )

inline

Assigns a name to entity. Ignored if used with pair. The string is copied and kept internally.

Parameters

name	A null-terminated string.
len	String length. If zero, the length is calculated.

Warning

Name is expected to be unique. If it is not this function does nothing.

The name can't contain the character '.'. This character is reserved for hierarchical lookups such as "parent.child.subchild".

name_raw()

void gaia::ecs::World::EntityBuilder::name_raw ( const char *  name, uint32_t  len = 0  )

inline

Assigns a name to entity. Ignored if used with pair. The string is NOT copied. Your are responsible for its lifetime.

Parameters

name	Pointer to a stable null-terminated string.
len	String length. If zero, the length is calculated.

Warning

The name is expected to be unique. If it is not this function does nothing.

The name can't contain the character '.'. This character is reserved for hierarchical lookups such as "parent.child.subchild".

In this case the string is NOT copied and NOT stored internally. You are responsible for its lifetime. The pointer also needs to be stable. Otherwise, any time your storage tries to move the string to a different place you have to unset the name before it happens and set it anew after the move is done.

register_component()

template<typename T >

Entity gaia::ecs::World::EntityBuilder::register_component ( )

inline

Takes care of registering the component.

Template Parameters

T

---

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

• /home/runner/work/gaia-ecs/gaia-ecs/include/gaia/ecs/world.h