Why use it
The boolean result makes success, availability or state explicit without exceptions.
EPOK RUNTIME
epok::is_active
Function · 2 overloads
Function
Reports whether active as part of the epok module.
Declaration 1 of 2
Declaration
bool is_active(const ActorData* entity)Reports whether active as part of the epok module.
| Parameter | Type | Meaning |
|---|---|---|
entity | const ActorData * | Value supplied for entity. 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 "epok.hpp"
// Assume these named values have been initialized with valid data:
// const ActorData * entity
auto result = epok::is_active(entity);Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations. 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/epok.hpp:191
Declaration 2 of 2
Declaration
inline bool is_active(Object* value)Reports whether active as part of the object model module.
| Parameter | Type | Meaning |
|---|---|---|
value | Object * | Value supplied for value. 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 "object_model.hpp"
// Assume these named values have been initialized with valid data:
// Object * value
auto result = epok::is_active(value);Why use it
The boolean result makes success, availability or state explicit without exceptions.
Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations. 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/object_model.hpp:1254
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