System

Base system class. More...

#include <ecsm.hpp>

Public Member Functions
virtual std::string_view	getComponentName () const
	Returns specific component name of the system.
virtual std::type_index	getComponentType () const
	Returns specific component typeid() of the system.
virtual View< Component >	getComponent (ID< Component > instance)
	Returns specific system component View.
virtual void	disposeComponents ()
	Actually destroys system components.

Protected Member Functions
virtual	~System ()=default
	Destroys system instance.
virtual ID< Component >	createComponent (ID< Entity > entity)
	Creates a new system component instance for the entity.
virtual void	destroyComponent (ID< Component > instance)
	Destroys system component instance.
virtual void	resetComponent (View< Component > component, bool full)
	Resets system component data.
virtual void	copyComponent (View< Component > source, View< Component > destination)
	Copies system component data from the source to destination.

Friends
class	Entity
class	Manager
class	SystemExt

Detailed Description

Base system class.

Systems are responsible for updating and processing entities with specific components. Each system typically focuses on a particular aspect of the game or simulation. Systems iterate over entities that have the necessary components and perform the required actions or calculations.

Constructor & Destructor Documentation

~System()

virtual ~System ( )

protectedvirtualdefault

Destroys system instance.

Warning

Override it to destroy unmanaged resources.

Member Function Documentation

createComponent()

virtual ID< Component > createComponent ( ID< Entity > entity )

protectedvirtual

Creates a new system component instance for the entity.

You should use Manager to add components to the entity.

Note

Override it to define a custom component of the system.

Parameters

entity

target entity instance

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

destroyComponent()

virtual void destroyComponent ( ID< Component > instance )

protectedvirtual

Destroys system component instance.

You should use Manager to remove components from the entity.

Note

Override it to define a custom component of the system.

Parameters

instance

target component instance

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

resetComponent()

virtual void resetComponent ( View< Component > component, bool full )

protectedvirtual

Resets system component data.

You should use Manager to reset entity components.

Note

Override it to define a custom component of the system.

Parameters

component	target component view
full	reset all component data

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

copyComponent()

virtual void copyComponent ( View< Component > source, View< Component > destination )

protectedvirtual

Copies system component data from the source to destination.

You should use Manager to copy component data of entities.

Note

Override it to define a custom component of the system.

Parameters

source	source component view (from)
destination	destination component view (to)

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

getComponentName()

virtual std::string_view getComponentName ( ) const

virtual

Returns specific component name of the system.

Note

Override it to define a custom component of the system.

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, ComponentSystem< DoNotDuplicateComponent, false >, DoNotDestroySystem, and DoNotDuplicateSystem.

getComponentType()

virtual std::type_index getComponentType ( ) const

virtual

Returns specific component typeid() of the system.

Note

Override it to define a custom component of the system.

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

getComponent()

virtual View< Component > getComponent ( ID< Component > instance )

virtual

Returns specific system component View.

Note

Override it to define a custom component of the system.

Parameters

instance

target component instance

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.

disposeComponents()

virtual void disposeComponents ( )

virtual

Actually destroys system components.

Components are not destroyed immediately, only after the dispose call.

Reimplemented in ComponentSystem< T, DestroyComponents >, ComponentSystem< DoNotDestroyComponent, false >, and ComponentSystem< DoNotDuplicateComponent, false >.