co_ecs::command_writer Class Reference

This class is responsible for writing commands to a command_buffer. More...

#include <command.hpp>

Public Member Functions
	command_writer (registry &reg)
	Constructs a command_writer with a given registry.
auto	get_entity (entity ent) -> command_entity_ref
	Retrieves a reference to a command entity.
template<component... Args>
auto	create (Args &&... args) -> command_entity_ref
	Creates a new entity with the given components.
void	destroy (entity ent)
	Destroys an existing entity.

Detailed Description

This class is responsible for writing commands to a command_buffer.

Example

registry reg;
command_writer cmd{reg};
 
auto e = cmd.create<position>({/* position data */});
e.set<velocity>({/* velocity data */});
 
command_buffer::flush(reg);
 
reg.get_entity(e).alive(); // true
reg.get_entity(e).has<position, velocity>(); // true

Constructor & Destructor Documentation

command_writer()

co_ecs::command_writer::command_writer ( registry & reg )

inline

Constructs a command_writer with a given registry.

Parameters

reg	Reference to a registry object.

Member Function Documentation

create()

template<component... Args>

auto co_ecs::command_writer::create ( Args &&... args ) -> command_entity_ref

inline

Creates a new entity with the given components.

Template Parameters

Args	Component types to be added to the entity.

Parameters

args	Components to be added to the entity.

Returns

A reference to the newly created command entity.

destroy()

void co_ecs::command_writer::destroy ( entity ent )

inline

Destroys an existing entity.

Parameters

ent	The entity to be destroyed.

get_entity()

auto co_ecs::command_writer::get_entity ( entity ent ) -> command_entity_ref

inline

Retrieves a reference to a command entity.

Parameters

ent	The entity to retrieve.

Returns

A reference to the command entity.

---

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

• include/co_ecs/command.hpp