Olympe::Task_SetVariable Class Reference

Atomic task that writes a value into the LocalBlackboard. More...

#include <Task_SetVariable.h>

Inheritance diagram for Olympe::Task_SetVariable:

Collaboration diagram for Olympe::Task_SetVariable:

Public Member Functions
	Task_SetVariable ()
TaskStatus	ExecuteWithContext (const AtomicTaskContext &ctx, const ParameterMap &params) override
	Executes the atomic task for one frame with full runtime context.
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

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 writes a value into the LocalBlackboard.

Definition at line 34 of file Task_SetVariable.h.

Constructor & Destructor Documentation

Task_SetVariable()

Olympe::Task_SetVariable::Task_SetVariable

(

)

Definition at line 17 of file Task_SetVariable.cpp.

Member Function Documentation

Abort()

void Olympe::Task_SetVariable::Abort ( )

overridevirtual

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 19 of file Task_SetVariable.cpp.

References SYSTEM_LOG.

Execute()

TaskStatus Olympe::Task_SetVariable::Execute ( const ParameterMap &  params )

overridevirtual

Executes the atomic task for one frame.

Parameters

params

Named 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 24 of file Task_SetVariable.cpp.

References Olympe::Failure.

ExecuteWithContext()

TaskStatus Olympe::Task_SetVariable::ExecuteWithContext ( const AtomicTaskContext &  ctx, const ParameterMap &  params  )

overridevirtual

Executes the atomic task for one frame with full runtime context.

New tasks should override this method to access the richer context (World pointer, LocalBlackboard, EntityID, dt, StateTimer). The default implementation simply forwards to Execute(params) so all existing tasks remain compatible without any changes.

Parameters

ctx	Runtime context for this tick (Entity, World*, LocalBB, dt, StateTimer).
params	Named parameters provided by the task graph node.

Returns

TaskStatus::Success, Failure, or Running.

Reimplemented from Olympe::IAtomicTask.

Definition at line 29 of file Task_SetVariable.cpp.

References Olympe::Failure, 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 files:

• Source/TaskSystem/AtomicTasks/Blackboard/Task_SetVariable.h
• Source/TaskSystem/AtomicTasks/Blackboard/Task_SetVariable.cpp