Task_SetSprite.h File Reference

Atomic task that sets the current sprite reference for an entity. More...

#include "../../IAtomicTask.h"

Include dependency graph for Task_SetSprite.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Olympe::Task_SetSprite
	Sets the current sprite reference via ECS or LocalBlackboard. More...

Namespaces
namespace	Olympe
	< Provides AssetID and INVALID_ASSET_ID

Detailed Description

Atomic task that sets the current sprite reference for an entity.

Author

Olympe Engine

Date

2026-03-08

Task_SetSprite updates the sprite displayed by an entity. In World mode (when a render component facade is available) it delegates to the render system. In headless mode it stores the sprite reference in the LocalBB.

Parameters (ParameterMap): "SpriteRef" (String) — sprite asset path or identifier (required).

Returns: Success after writing the sprite reference. Failure if "SpriteRef" is missing.

C++14 compliant - no C++17/20 features.

Definition in file Task_SetSprite.h.