Central context for the ECS. More...

#include <world.hpp>

Public Member Functions
	World ()
	Constructs a new World, initializing managers.
Entity	Spawn ()
	Spawns a new entity.
void	AddStageBefore (std::string name, std::string after)
	Creates a stage before another.
void	AddStageAfter (std::string name, std::string before)
	Creates a stage before another.
template<typename... Cs, typename... Overrides>
Entity	SpawnWith (Overrides &&... overrides)
	Spawns an entity with components.
void	Despawn (Entity entity)
	Despawns(destroys) an entity.
template<typename T>
void	RegisterComponent ()
	Registers a new component type with the ECS.
template<typename T>
bool	HasComponent (Entity entity)
	Checks if en entity has a component.
template<typename... Components, typename Func>
void	View (Func &&func)
template<typename T, typename... Args>
void	AddComponent (Entity entity, Args &&... args)
	Adds a component to an entity.
template<typename T>
void	RemoveComponent (Entity entity)
	Removes a component from an entity.
template<typename T>
T &	GetComponent (Entity entity)
	Retrieves a reference to a component on an entity.
template<typename T>
ComponentID	GetComponentID ()
	Retrieves the unique ID associated with a component type.
template<typename... Components>
Signature	MakeSignature ()
	Creates a signature that includes all specified component types.
template<typename T>
std::shared_ptr< T >	RegisterSystem (Signature signature={}, std::string stage="Update")
	Registers a system of type T.
template<typename Func>
std::shared_ptr< System >	RegisterSystemExplicit (Func &&func, Signature signature={}, std::string stage="Update")
	Registers a system explicitly from a function object or lambda.
template<typename... Components, typename Func>
std::shared_ptr< System >	RegisterSystem (Func &&func, std::string stage="Update")
	Registers a system from a lambda or callable with component type deduction.
template<typename T>
void	SetSystemSignature (Signature signature)
	Sets the component signature for a system.
template<typename T>
void	SetSingleton (T value)
	Stores a singleton instance in the world.
template<typename T>
T &	GetSingleton ()
	Retrieves a singleton instance from the world.
template<typename T>
bool	IsSingletonSet ()
	Checks if singleton is set.
template<typename T>
void	Import ()
	Imports a module into the world.
template<typename T>
void	SubscribeEvent (EventManager::Callback< T > cb)
	Subscribes a callback to an event.
template<typename T>
void	EmitEvent (const T &event)
	Emit an event to the event queue.
void	DispatchEvents ()
	Dispatch events.
void	Update (double dt=0.0)
	Runs system updates in the world.

Detailed Description

Central context for the ECS.

This class manages EVERYTHING to do with the ECS

Member Function Documentation

◆ AddComponent()

template<typename T, typename... Args>

void acheron::ecs::World::AddComponent	(	Entity	entity,
		Args &&...	args )

inline

Adds a component to an entity.

Also updates the entity's signature and notifies systems

Template Parameters

T	Component type

Parameters

entity	The entity receiving the component
component	Optional instance of the component (default constructed if omitted)

◆ AddStageAfter()

void World::AddStageAfter	(	std::string	name,
		std::string	before )

Creates a stage before another.

Parameters

name	The name of the system to register after
after	The system that will be before the registered stage

◆ AddStageBefore()

void World::AddStageBefore	(	std::string	name,
		std::string	after )

Creates a stage before another.

Parameters

name	The name of the system to register before
after	The system that will be after the registered stage

◆ Despawn()

void World::Despawn ( Entity entity )

Despawns(destroys) an entity.

Cleans up all associated components and notifies systems

Parameters

entity The entity to remove

◆ EmitEvent()

template<typename T>

void acheron::ecs::World::EmitEvent ( const T & event )

inline

Emit an event to the event queue.

Template Parameters

T	Event type to emit

Parameters

event Event and its data

◆ GetComponent()

template<typename T>

T & acheron::ecs::World::GetComponent ( Entity entity )

inline

Retrieves a reference to a component on an entity.

Template Parameters

T	Component type

Parameters

entity The entity to query

Returns: Reference to the component

◆ GetComponentID()

template<typename T>

ComponentID acheron::ecs::World::GetComponentID ( )

inline

Retrieves the unique ID associated with a component type.

Template Parameters

T	Component type

Returns: ComponentID for the given type

◆ GetSingleton()

template<typename T>

T & acheron::ecs::World::GetSingleton ( )

inline

Retrieves a singleton instance from the world.

Template Parameters

T	Singleton type

Returns: Reference to the stored singleton

Exceptions

Assert failure if the singleton has not been set

◆ HasComponent()

template<typename T>

bool acheron::ecs::World::HasComponent ( Entity entity )

inline

Checks if en entity has a component.

Parameters

entity The entity to check

Returns: If component has entity

◆ Import()

template<typename T>

void acheron::ecs::World::Import ( )

inline

Imports a module into the world.

The module must inherit from Module

Template Parameters

T	Module type

◆ IsSingletonSet()

template<typename T>

bool acheron::ecs::World::IsSingletonSet ( )

inline

Checks if singleton is set.

Template Parameters

T	The singleton to check

Returns: If the singleton is set or not

◆ MakeSignature()

template<typename... Components>

Signature acheron::ecs::World::MakeSignature ( )

inline

Creates a signature that includes all specified component types.

Template Parameters

Components... Variadic list of component types

Returns: Signature representing the component set

◆ RegisterComponent()

template<typename T>

void acheron::ecs::World::RegisterComponent ( )

inline

Registers a new component type with the ECS.

Template Parameters

T	The component type to register

◆ RegisterSystem() [1/2]

template<typename... Components, typename Func>

std::shared_ptr< System > acheron::ecs::World::RegisterSystem	(	Func &&	func,
		std::string	stage = "Update" )

inline

Registers a system from a lambda or callable with component type deduction.

Example:

world.RegisterSystem<Position, Velocity>(
    [](Entity e, Position& pos, Velocity& vel) { ... }
);

Template Parameters

Components...	The component types the system operates on
Func	Callable type

Parameters

func	The system function/lambda
stage	The update stage (default Update)

Returns: Shared pointer to the created system

◆ RegisterSystem() [2/2]

template<typename T>

std::shared_ptr< T > acheron::ecs::World::RegisterSystem	(	Signature	signature = {},
		std::string	stage = "Update" )

inline

Registers a system of type T.

Template Parameters

T	System type (must inherit from System)

Parameters

signature	The component signature this system cares about (default empty)
stage	The update stage to run this system in (default Update)

Returns: Shared pointer to the created system

◆ RegisterSystemExplicit()

template<typename Func>

std::shared_ptr< System > acheron::ecs::World::RegisterSystemExplicit	(	Func &&	func,
		Signature	signature = {},
		std::string	stage = "Update" )

inline

Registers a system explicitly from a function object or lambda.

Allows flexible system definition without requiring a class

Template Parameters

Func	Callable type.

Parameters

func	The system function/lambda
signature	Component signature this system cares about (default empty)
stage	Update stage to run the system in (default Update)

Returns: Shared pointer to the created system

◆ RemoveComponent()

template<typename T>

void acheron::ecs::World::RemoveComponent ( Entity entity )

inline

Removes a component from an entity.

Updates the entity's signature and notifies systems

Template Parameters

T	Component type to remove

Parameters

entity The entity to modify

◆ SetSingleton()

template<typename T>

void acheron::ecs::World::SetSingleton ( T value )

inline

Stores a singleton instance in the world.

Template Parameters

T	Singleton type

Parameters

value The instance to store

◆ SetSystemSignature()

template<typename T>

void acheron::ecs::World::SetSystemSignature ( Signature signature )

inline

Sets the component signature for a system.

Template Parameters

T	System type

Parameters

signature The signature to associate with the system

◆ Spawn()

Entity World::Spawn ( )

Spawns a new entity.

Returns: The newly created entity

◆ SpawnWith()

template<typename... Cs, typename... Overrides>

Entity acheron::ecs::World::SpawnWith ( Overrides &&... overrides )

inline

Spawns an entity with components.

Example:

world.SpawnWith<Player, Health>(Health{20});

Template Parameters

Cs	Components that are to be added to the entity
Overrides	The actual component data passed to the function

Parameters

overrides Same as the template parameter Overrides

Exceptions

Static Assert Fail if Overrides has a type Cs doesnt contain

Returns: The newly created entity with the components specified

◆ SubscribeEvent()

template<typename T>

void acheron::ecs::World::SubscribeEvent ( EventManager::Callback< T > cb )

inline

Subscribes a callback to an event.

Template Parameters

T	Event type

Parameters

cb	Callback to subscribe to the event

◆ Update()

void World::Update ( double dt = 0.0 )

Runs system updates in the world.

Systems are executed in stage order:

Start (once)
PreUpdate
Update
PostUpdate

Parameters

dt	Delta time passed to systems (default 0.0)

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

src/ecs/world.hpp
src/ecs/world.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddComponent()

◆ AddStageAfter()

◆ AddStageBefore()

◆ Despawn()

◆ EmitEvent()

◆ GetComponent()

◆ GetComponentID()

◆ GetSingleton()

◆ HasComponent()

◆ Import()

◆ IsSingletonSet()

◆ MakeSignature()

◆ RegisterComponent()

◆ RegisterSystem() [1/2]

◆ RegisterSystem() [2/2]

◆ RegisterSystemExplicit()

◆ RemoveComponent()

◆ SetSingleton()

◆ SetSystemSignature()

◆ Spawn()

◆ SpawnWith()

◆ SubscribeEvent()

◆ Update()