register_event_handler(event_name, handler)

Register a handler function for a specific event.

#Parameters::

• event_name: Name of the event to handle (e.g., 'on_key_down').
• handler: The function to call when the event occurs.

set_event_handling_active(active)

Set the flag to enable or disable event handling.

#Parameters::

• active: True to enable event handling, False to disable it.

handle_events()

Handle Pygame events by calling registered Lua event handlers. This function should be called regularly to process events and keep the UI responsive.

get_event()

Get a single event from the event queue. Equivalent to pygame.event.get() but returns a single event.

get_events(eventtype=None, pump=True, exclude=None)

Get events from the event queue. Equivalent to pygame.event.get(eventtype, pump, exclude).

#Parameters::

• eventtype: The type of events to get.
• pump: Whether to pump the event queue.
• exclude: Events to exclude from the returned list.

pump_events()

Pump the event queue to keep the UI responsive. Equivalent to pygame.event.pump().

poll_event()

Poll for a single event from the event queue. Equivalent to pygame.event.poll().

wait_event()

Wait for a single event from the event queue. Equivalent to pygame.event.wait().

peek_event(eventtype=None)

Check if there are events of a certain type in the event queue. Equivalent to pygame.event.peek(eventtype).

#Parameters::

• eventtype: The type of events to check for.

clear_events(eventtype=None)

Clear events from the event queue. Equivalent to pygame.event.clear(eventtype).

#Parameters::

• eventtype: The type of events to clear.

event_name(event_id)

Get the name of an event given its ID. Equivalent to pygame.event.event_name(event_id).

#Parameters::

• event_id: The ID of the event.

set_blocked(eventtype)

Block a certain type of event. Equivalent to pygame.event.set_blocked(eventtype).

#Parameters::

• eventtype: The type of event to block.

set_allowed(eventtype)

Allow a certain type of event. Equivalent to pygame.event.set_allowed(eventtype).

#Parameters::

• eventtype: The type of event to allow.

get_blocked(eventtype)

Check if a certain type of event is blocked. Equivalent to pygame.event.get_blocked(eventtype).

#Parameters::

• eventtype: The type of event to check.

set_grab(grab)

Set the input grab mode. Equivalent to pygame.event.set_grab(grab).

#Parameters::

• grab: Boolean flag to enable or disable input grab.

get_grab()

Get the current input grab mode. Equivalent to pygame.event.get_grab().

set_keyboard_grab(grab)

Set the keyboard input grab mode. Equivalent to pygame.event.set_keyboard_grab(grab).

#Parameters::

• grab: Boolean flag to enable or disable keyboard input grab.

get_keyboard_grab()

Get the current keyboard input grab mode. Equivalent to pygame.event.get_keyboard_grab().

post_event(event)

Post a new event to the event queue. Equivalent to pygame.event.post(event).

#Parameters::

• event: The event to post.

custom_event_type()

Create a new custom event type. Equivalent to pygame.event.custom_type().

Event(eventtype, dict=None)

Create a new event object. Equivalent to pygame.event.Event(eventtype, dict).

#Parameters::

• eventtype: The type of event to create.
• dict: Dictionary of attributes for the event.

Event constants

• MOUSEBUTTONDOWN: Mouse button down event
• MOUSEBUTTONUP: Mouse button up event
• MOUSEMOTION: Mouse motion event
• QUIT: Quit event
• VIDEORESIZE: Video resize event
• KEYDOWN: Key down event
• KEYUP: Key up event