Epok Engine

EPOK RUNTIME

epok::effects::configure

Function · 1 overload

Function

Performs `configure` as part of runtime effects and their deterministic playback state.

Belongs to
epok::effects
Header
particle_effect_service.hpp
Overloads
1

Declaration

Declaration
inline Component* configure(DataHandle owner,const Asset& asset,bool enabled,bool automatic,uint32_t seed)

Performs `configure` as part of runtime effects and their deterministic playback state.

ParameterTypeMeaning
ownerDataHandleValue supplied for owner. Keep referenced or pointed-to data valid for the complete call.
assetconst Asset &Value supplied for asset. Keep referenced or pointed-to data valid for the complete call.
enabledboolValue supplied for enabled. Keep referenced or pointed-to data valid for the complete call.
automaticboolValue supplied for automatic. Keep referenced or pointed-to data valid for the complete call.
seeduint32_tValue supplied for seed. Keep referenced or pointed-to data valid for the complete call.

Returns: Component *. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "particle_effect_service.hpp"

// Assume these named values have been initialized with valid data:
// DataHandle owner
// const Asset & asset
// bool enabled
// bool automatic
// uint32_t seed

auto result = epok::effects::configure(owner, asset, enabled, automatic, seed);

Why use it

It provides direct, allocation-conscious access to runtime effects and their deterministic playback state. No exception-based error path is implied by the signature.

Trade-offs and warnings

Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/particle_effect_service.hpp:28

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