Why use it
It provides direct, allocation-conscious access to compiled Blueprint execution and object interaction. No exception-based error path is implied by the signature.
EPOK RUNTIME
epok::bp::api::play_effect_component
Function · 2 overloads
Function
Starts effect component as part of compiled Blueprint execution and object interaction.
Declaration 1 of 2
Declaration
effects::Handle play_effect_component(DataHandle)Starts effect component as part of compiled Blueprint execution and object interaction.
| Parameter | Type | Meaning |
|---|---|---|
arg1 | DataHandle | Value supplied for arg1. Keep referenced or pointed-to data valid for the complete call. |
Returns: effects::Handle. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "blueprint_api.hpp"
// Assume these named values have been initialized with valid data:
// DataHandle arg1
auto result = epok::bp::api::play_effect_component(arg1);Trade-offs and warnings
Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.
Declared in runtime/blueprint_api.hpp:13
Declaration 2 of 2
Declaration
inline effects::Handle play_effect_component(ObjectId target)Starts effect component as part of compiled Blueprint execution and object interaction.
| Parameter | Type | Meaning |
|---|---|---|
target | ObjectId | Value supplied for target. Keep referenced or pointed-to data valid for the complete call. |
Returns: effects::Handle. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "blueprint_api.hpp"
// Assume these named values have been initialized with valid data:
// ObjectId target
auto result = epok::bp::api::play_effect_component(target);Why use it
It provides direct, allocation-conscious access to compiled Blueprint execution and object interaction. No exception-based error path is implied by the signature.
Trade-offs and warnings
Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.
Declared in runtime/blueprint_api.hpp:75
Related members
aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function templateaabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function templateaabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Functionaabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Functionaabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Functionaabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Functionactivate_texture_bankPerforms `activate texture bank` as part of the epok module.Functionactive_cameraPerforms `active camera` as part of the epok module.Functionactor_for_slotPerforms `actor for slot` as part of the actor tables module.Functionallocate_actor_dataPerforms `allocate actor data` as part of the epok module.Functionattach_componentSpatial attachment between components of the same domain.Functionaudio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function