ecstasy::Entities::Builder Class Reference

Entities builder to add multiple component to an entity on creation. More...

#include <Entities.hpp>

Collaboration diagram for ecstasy::Entities::Builder:

Public Member Functions
	Builder (const Builder &other)=delete
	Cannot copy a builder.
template<IsStorage S, typename... Args>
Builder &	with (S &storage, Args &&...args)
	Add a component to the builder target entity.
template<IsContainerStorage S>
Builder &	with (S &storage, std::initializer_list< typename S::Component::value_type > list)
	Add a component to the builder target entity.
Entity	build ()
	Finalize the entity, making it alive.
const Entity &	getEntity () const noexcept
	Get a const reference to the entity being built.

Private Member Functions
	Builder (Entities &parent, Entity entity) noexcept
	Construct a new Builder, this method can only be called by an Entities.
void	assertNotBuilt () const
	Verify if the builder has not already been consumed.

Private Attributes
Entities &	_parent
	Reference to the parent Entities.
Entity	_entity
	Entity being built.
bool	_built
	Whether the builder has been consumed.
friend	Entities

Detailed Description

Entities builder to add multiple component to an entity on creation.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Definition at line 38 of file Entities.hpp.

Constructor & Destructor Documentation

Builder() [1/2]

ecstasy::Entities::Builder::Builder ( const Builder &  other )

delete

Cannot copy a builder.

Parameters

[in]

other

builder to copy.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Builder() [2/2]

ecstasy::Entities::Builder::Builder ( Entities &  parent, Entity  entity  )

privatenoexcept

Construct a new Builder, this method can only be called by an Entities.

Parameters

[in]	parent	Entities object creating this builder.
[in]	entity	Entity target (modified by the builder).

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Definition at line 16 of file Entities.cpp.

        : _parent(parent), _entity(entity), _built(false)
    {
    }

Member Function Documentation

assertNotBuilt()

void ecstasy::Entities::Builder::assertNotBuilt ( ) const

private

Verify if the builder has not already been consumed.

Exceptions

std::logic_error

if _built is true.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Definition at line 21 of file Entities.cpp.

    {
        if (_built) [[unlikely]]
            throw std::logic_error(
                "Try to change entity using an Entities::Builder already consumed (build() has been called)");
    }

build()

Entity ecstasy::Entities::Builder::build

(

)

Finalize the entity, making it alive.

Note

This method can only be called once.

Returns

Entity Newly created entity.

Exceptions

std::logic_error

If the builder was already consumed.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Definition at line 28 of file Entities.cpp.

    {
        assertNotBuilt();
        _built = true;
        _parent._alive[_entity.getIndex()] = true;
        return _entity;
    }

getEntity()

const Entity & ecstasy::Entities::Builder::getEntity ( ) const

inlinenoexcept

Get a const reference to the entity being built.

Warning

This method is here in case you need the entity id before calling build(). For example if you need it inside a component constructor.

Returns

const Entity& Entity being built.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-06-07)

Definition at line 124 of file Entities.hpp.

            {
                return _entity;
            }

with() [1/2]

template<IsStorage S, typename... Args>

Builder & ecstasy::Entities::Builder::with ( S &  storage, Args &&...  args  )

inline

Add a component to the builder target entity.

Template Parameters

S	Component storage type.
Args	Type of the Component constructor parameters

Parameters

[in]	storage	Component storage.
[in]	args	Arguments to forward to the component constructor.

Returns

Builder& this.

Exceptions

std::logic_error

If the builder was already consumed or if the entity already has the component.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-10-19)

Definition at line 68 of file Entities.hpp.

            {
                assertNotBuilt();
                _entity.add(storage, std::forward<Args>(args)...);
                return *this;
            }

with() [2/2]

template<IsContainerStorage S>

Builder & ecstasy::Entities::Builder::with ( S &  storage, std::initializer_list< typename S::Component::value_type >  list  )

inline

Add a component to the builder target entity.

Template Parameters

S	Component storage type.

Parameters

[in]	storage	Component storage.
[in]	list	Initializer list to forward to the component constructor.

Returns

Builder& this.

Exceptions

std::logic_error

If the builder was already consumed or if the entity already has the component.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2023-01-31)

Definition at line 92 of file Entities.hpp.

            {
                assertNotBuilt();
                _entity.add(storage, list);
                return *this;
            }

Member Data Documentation

_built

bool ecstasy::Entities::Builder::_built

private

Whether the builder has been consumed.

Definition at line 135 of file Entities.hpp.

_entity

Entity ecstasy::Entities::Builder::_entity

private

Entity being built.

Definition at line 133 of file Entities.hpp.

_parent

Entities& ecstasy::Entities::Builder::_parent

private

Reference to the parent Entities.

Definition at line 131 of file Entities.hpp.

Entities

friend ecstasy::Entities::Builder::Entities

private

Definition at line 158 of file Entities.hpp.

---

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

• src/ecstasy/resources/entity/Entities.hpp
• src/ecstasy/resources/entity/Entities.cpp