Skip to content

textmode.js / Textmodifier / on

Method: on()

ts
on<K>(event, handler): () => void;

Register an input event listener.

Multiple listeners can coexist on the same event; unlike the legacy single-callback methods (e.g. mousePressed()), calling on() never replaces existing listeners.

Type Parameters

Type ParameterDescription
K extends | keyof KeyboardEventMap | keyof MouseEventMap | keyof TouchEventMap | keyof GamepadEventMapEvent name from the InputEventMap.

Parameters

ParameterTypeDescription
eventKThe event to listen for (e.g. 'mousePressed', 'keyReleased', 'gamepadConnected', 'pinch').
handlerInputEventMap[K]The callback to invoke when the event fires.

Returns

A dispose function that removes this specific listener.

() => void

Example

ts
// Add a click listener
const dispose = t.on('mouseClicked', (data) => {
  console.log('Clicked at', data.position.x, data.position.y);
});

// Later, remove it
dispose();