EPOK RUNTIME

epok::timeline::poll_marker

Function · 1 overload

Function

Sorted tables use (tick, persistent marker ID) at cook time.

Belongs to: epok::timeline
Header: timeline.hpp
Overloads: 1

Declaration

inline bool poll_marker(const Marker* markers, uint16_t count, uint16_t& cursor, int32_t tick, uint16_t& id)

Sorted tables use (tick, persistent marker ID) at cook time.

Parameter	Type	Meaning
`markers`	`const Marker *`	Value supplied for markers. Keep referenced or pointed-to data valid for the complete call.
`count`	`uint16_t`	Value supplied for count. Keep referenced or pointed-to data valid for the complete call.
`cursor`	`uint16_t &`	Value supplied for cursor. Keep referenced or pointed-to data valid for the complete call.
`tick`	`int32_t`	Value supplied for tick. Keep referenced or pointed-to data valid for the complete call.
`id`	`uint16_t &`	Value supplied for id. 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 "timeline.hpp"

// Assume these named values have been initialized with valid data:
// const Marker * markers
// uint16_t count
// uint16_t & cursor
// int32_t tick
// uint16_t & id

auto result = epok::timeline::poll_marker(markers, count, cursor, tick, id);

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/timeline.hpp:57

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function