Olympe Engine 2.0
2D Game Engine with ECS Architecture
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Olympe::Task_LogMessage Class Reference

Atomic task that logs the value of the "message" parameter. More...

+ Inheritance diagram for Olympe::Task_LogMessage:
+ Collaboration diagram for Olympe::Task_LogMessage:

Public Member Functions

TaskStatus Execute (const ParameterMap &params) override
 Executes the atomic task for one frame.
 
void Abort () override
 Aborts the task, releasing any in-progress state.
 
- Public Member Functions inherited from Olympe::IAtomicTask
virtual ~IAtomicTask ()=default
 
virtual TaskStatus ExecuteWithContext (const AtomicTaskContext &ctx, const ParameterMap &params)
 Executes the atomic task for one frame with full runtime context.
 

Additional Inherited Members

- Public Types inherited from Olympe::IAtomicTask
using ParameterMap = std::unordered_map< std::string, TaskValue >
 Convenience alias for the parameter map passed to Execute().
 

Detailed Description

Atomic task that logs the value of the "message" parameter.

Definition at line 26 of file Task_LogMessage.cpp.

Member Function Documentation

◆ Abort()

void Olympe::Task_LogMessage::Abort ( )
inlineoverridevirtual

Aborts the task, releasing any in-progress state.

Called by the TaskSystem when execution is interrupted (e.g. a parent node is aborted or a new graph is bound while a task is Running). Concrete tasks must implement this to clean up timers, reservations, animations, or any other side-effects started in Execute().

Implements Olympe::IAtomicTask.

Definition at line 44 of file Task_LogMessage.cpp.

◆ Execute()

TaskStatus Olympe::Task_LogMessage::Execute ( const ParameterMap params)
inlineoverridevirtual

Executes the atomic task for one frame.

Parameters
paramsNamed parameters provided by the task graph node.
Returns
TaskStatus::Success, Failure, or Running. Returning Running causes the task to be ticked again next frame.

Implements Olympe::IAtomicTask.

Definition at line 29 of file Task_LogMessage.cpp.

References GetComponentTypeID_Static(), Olympe::String, Olympe::Success, and SYSTEM_LOG.

+ Here is the call graph for this function:

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