EPOK RUNTIME

epok::UtilityLibrary::event_queue_emit

Method · 1 overload

Method

Performs `event queue emit` as part of the utility module.

Belongs to: epok::UtilityLibrary
Header: utility.hpp
Overloads: 1

Declaration

static

Declaration

static EventQueueMutation event_queue_emit(GameplayEventQueue4 state,uint32_t kind,int32_t value,ObjectId source)

Performs `event queue emit` as part of the utility module.

Parameter	Type	Meaning
`state`	`GameplayEventQueue4`	Value supplied for state. Keep referenced or pointed-to data valid for the complete call.
`kind`	`uint32_t`	Value supplied for kind. Keep referenced or pointed-to data valid for the complete call.
`value`	`int32_t`	Value supplied for value. Keep referenced or pointed-to data valid for the complete call.
`source`	`ObjectId`	Value supplied for source. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example

#include "utility.hpp"

// Assume these named values have been initialized with valid data:
// GameplayEventQueue4 state
// uint32_t kind
// int32_t value
// ObjectId source

auto result = epok::UtilityLibrary::event_queue_emit(state, kind, value, source);

Why use it

The asynchronous shape lets the frame loop continue while hardware or queued work completes.

Trade-offs and warnings

Captured data and buffers must remain valid until the callback or task has completed.

Declared in runtime/utility.hpp:186

Related members

easeThe easing catalogue on its own, for curves applied to something that is not a tween.Method event_queue_clearPerforms `event queue clear` as part of the utility module.Method event_queue_pollPerforms `event queue poll` as part of the utility module.Method tween_advancePerforms `tween advance` as part of the utility module.Method tween_cancelPerforms `tween cancel` as part of the utility module.Method tween_scheduleThe full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.Method tween_startPerforms `tween start` as part of the utility module.Method tween_valuePerforms `tween value` as part of the utility module.Method