Why use it
The boolean result makes success, availability or state explicit without exceptions.
EPOK RUNTIME
epok::effects::stop
Function · 1 overload
Function
Stops stop as part of runtime effects and their deterministic playback state.
Declaration
Declaration
inline bool stop(Handle handle)Stops stop as part of runtime effects and their deterministic playback state.
| Parameter | Type | Meaning |
|---|---|---|
handle | Handle | Value supplied for handle. Keep referenced or pointed-to data valid for the complete call. |
Returns: bool. 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:
// Handle handle
auto result = epok::effects::stop(handle);Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations.
Declared in runtime/particle_effect_service.hpp:47
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