Zernikalos/zernikalos.events/ZEventQueue

ZEventQueue

class ZEventQueue(context: ZContext) : ZUserInputEventHandler(source)

Event queue that accumulates user input events and processes them synchronously during the game loop frame update phase.

This class replaces ZEventBus by providing both event queuing and distribution functionality. Events are enqueued asynchronously when they arrive from the input system, and then processed synchronously during processAll() which is called from the renderer's update phase.

This ensures that all events are processed at the correct time in the frame, synchronized with the game loop, similar to how Unity, Unreal, and Godot handle input events.

Parameters

context

The ZContext containing the scene to distribute events to

Constructors

ZEventQueue

constructor(context: ZContext)

Properties

isEmpty

val isEmpty: Boolean

Returns whether there are any events pending in the queue.

Functions

enqueueKeyboard

fun enqueueKeyboard(event: ZKeyboardEvent)

Enqueues a keyboard event to be processed during the next frame update.

enqueueMouse

fun enqueueMouse(event: ZMouseEvent)

Enqueues a mouse event to be processed during the next frame update.

enqueueTouch

fun enqueueTouch(event: ZTouchEvent)

Enqueues a touch event to be processed during the next frame update.

onKeyboardEvent

open override fun onKeyboardEvent(event: ZKeyboardEvent)

Called when a keyboard event occurs. Enqueues the event for processing during the next frame update.

onMouseEvent

open override fun onMouseEvent(event: ZMouseEvent)

Called when a mouse event occurs. Enqueues the event for processing during the next frame update.

onTouchEvent

open override fun onTouchEvent(event: ZTouchEvent)

Called when a touch event occurs. Enqueues the event for processing during the next frame update.

processAll

fun processAll()

Processes all enqueued events by distributing them to objects in the scene that have registered listeners. This method should be called from the renderer's update phase to ensure events are processed synchronously with the game loop.