Skip to content
ipygame

ipygame.event

pygame-compatible event module.

Event Objects

Section titled “Event Objects”
class Event()

Represents a single event, compatible with pygame.event.Event.

__init__

Section titled “__init__”
def __init__(event_type: int, attributes: dict | None = None, **kwargs)

dict

Section titled “dict”
@property
def dict() -> dict

pump

Section titled “pump”
def pump() -> None

Internal processing — no-op in ipygame (events arrive via callbacks).

get

Section titled “get”
def get(eventtype=None, pump: bool = True, exclude=None) -> list[Event]

Get and remove events from the queue.

eventtype can be a single type int, a sequence of types, or None (all events).

poll

Section titled “poll”
def poll() -> Event

Get a single event from the queue (or NOEVENT).

wait

Section titled “wait”
def wait(timeout: int = 0) -> Event

Wait for an event. In Jupyter this just polls (blocking not advisable).

peek

Section titled “peek”
def peek(eventtype=None) -> bool

Return True if there are events of the given type in the queue.

clear

Section titled “clear”
def clear(eventtype=None) -> None

Remove events from the queue.

post

Section titled “post”
def post(event: Event) -> bool

Place an event on the queue.

event_name

Section titled “event_name”
def event_name(event_type: int) -> str

Return a human-readable name for event_type.

set_blocked

Section titled “set_blocked”
def set_blocked(event_type) -> None

set_allowed

Section titled “set_allowed”
def set_allowed(event_type) -> None

get_blocked

Section titled “get_blocked”
def get_blocked(event_type: int) -> bool

set_grab

Section titled “set_grab”
def set_grab(grab: bool) -> None

get_grab

Section titled “get_grab”
def get_grab() -> bool

custom_type

Section titled “custom_type”
def custom_type() -> int

Allocate and return a unique event type id.