Task_GetWorldInstance.h File Reference

Atomic task that resolves a named World entity and stores its ID. More...

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

Include dependency graph for Task_GetWorldInstance.h:

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

Go to the source code of this file.

Classes
class	Olympe::Task_GetWorldInstance
	Finds an entity by name in World and stores its EntityID in LocalBB. More...

Namespaces
namespace	Olympe
	< Provides AssetID and INVALID_ASSET_ID

Detailed Description

Atomic task that resolves a named World entity and stores its ID.

Author

Olympe Engine

Date

2026-03-08

Task_GetWorldInstance looks up an entity by name in the live World and stores the resulting EntityID under "local:TargetInstance" in the LocalBlackboard. When ctx.WorldPtr is null (headless / test mode) the task logs a warning and returns Failure.

Parameters (ParameterMap): "InstanceName" (String) — name of the entity to locate (required).

Returns: Success if the entity was found (EntityID written to LocalBB). Failure if InstanceName is missing, WorldPtr is null, or entity not found.

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

Definition in file Task_GetWorldInstance.h.