Helios Engine 0.1.0
A modular ECS based data-oriented C++23 game engine
 
Loading...
Searching...
No Matches
helios::ecs::details::ClearEventsCmd< T > Class Template Referencefinal

Command to clear all events of a specific type from the queue. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::ClearEventsCmd< T >:
helios::ecs::Command

Public Member Functions

constexpr ClearEventsCmd () noexcept=default
 
constexpr ClearEventsCmd (const ClearEventsCmd &) noexcept=default
 
constexpr ClearEventsCmd (ClearEventsCmd &&) noexcept=default
 
constexpr ~ClearEventsCmd () noexcept override=default
 
constexpr ClearEventsCmdoperator= (const ClearEventsCmd &) noexcept=default
 
constexpr ClearEventsCmdoperator= (ClearEventsCmd &&) noexcept=default
 
void Execute (World &world) override
 Executes the command to clear events of type T.
 
- Public Member Functions inherited from helios::ecs::Command
virtual constexpr ~Command () noexcept=default
 

Detailed Description

template<EventTrait T>
class helios::ecs::details::ClearEventsCmd< T >

Command to clear all events of a specific type from the queue.

Template Parameters
TEvent type to clear

Definition at line 751 of file commands.hpp.

Constructor & Destructor Documentation

◆ ClearEventsCmd() [1/3]

template<EventTrait T>
constexpr helios::ecs::details::ClearEventsCmd< T >::ClearEventsCmd ( )
constexprdefaultnoexcept

◆ ClearEventsCmd() [2/3]

template<EventTrait T>
constexpr helios::ecs::details::ClearEventsCmd< T >::ClearEventsCmd ( const ClearEventsCmd< T > &  )
constexprdefaultnoexcept

◆ ClearEventsCmd() [3/3]

template<EventTrait T>
constexpr helios::ecs::details::ClearEventsCmd< T >::ClearEventsCmd ( ClearEventsCmd< T > &&  )
constexprdefaultnoexcept

◆ ~ClearEventsCmd()

template<EventTrait T>
constexpr helios::ecs::details::ClearEventsCmd< T >::~ClearEventsCmd ( )
constexproverridedefaultnoexcept

Member Function Documentation

◆ Execute()

template<EventTrait T>
void helios::ecs::details::ClearEventsCmd< T >::Execute ( World world)
inlineoverridevirtual

Executes the command to clear events of type T.

Parameters
worldReference to the world

Implements helios::ecs::Command.

Definition at line 765 of file commands.hpp.

765{ world.ClearEvents<T>(); }
BasicQuery< World, Allocator, Components... > Query
Type alias for query with mutable world access.
Definition query.hpp:2481

◆ operator=() [1/2]

template<EventTrait T>
constexpr ClearEventsCmd & helios::ecs::details::ClearEventsCmd< T >::operator= ( ClearEventsCmd< T > &&  )
constexprdefaultnoexcept

◆ operator=() [2/2]

template<EventTrait T>
constexpr ClearEventsCmd & helios::ecs::details::ClearEventsCmd< T >::operator= ( const ClearEventsCmd< T > &  )
constexprdefaultnoexcept