Event Details

Events can be broadcast with rb.Radio.broadcast():

>>> rb.Radio.broadcast("EVENT_NAME", {data})

rubato broadcasts some events already, but you can also define your own events using this function!

These events can also be listened to with rb.Radio.listen(). Here is an example of how you can listen for a key down event:

def listener(data):
    if data["key"] == "a":
        print("You pressed the 'a' key!")

rb.Radio.listen("KEYDOWN", listener)

Below is a list of all the events that are broadcast by rubato:

Key Events

There are 3 key events that are broadcast.

"KEYUP" # Fired when a key is released
"KEYDOWN" # Fired when a key is pressed
"KEYHOLD" # Fired when a key is held down (After the initial keydown)

Each event gives a dictionary with the following information:

{
    "key": str, # The name of the key (see Key Names section for the list of possible key names)
    "unicode": str, # The unicode character for the key (keys without unicode are just empty strings)
    "code": int, # The keycode of the the key. (can be processed with Input.get_name)
    "mods": int, # The code for the currently pressed modifiers. (can be processed with Input.mods_from_code)
}

Mouse Events

There are 2 key events that are broadcast.

"MOUSEUP" # Fired when a mouse button is released
"MOUSEDOWN" # Fired when a mouse button is pressed
"MOUSEWHEEL" # Fired when the mouse wheel is scrolled

Each event gives a dictionary with the following information:

{
    "button": int,
    "x": int,
    "y": int,
    "clicks": int,
    "which": int,
    "windowID": int,
    "timestamp": int,
}

The mouse wheel event has the following information: Note: y is regular scroll up (positive) and down (negative), and x is horizontal scroll left (negative) and right (positive). X scrolling can come from a some computer mice, and trackpads.

{
    "x": int,
    "y": int,
    "precise x": float,
    "precise y": float,
    "which": int,
    "windowID": int,
    "timestamp": int,
}

Window Events

There is 1 window event that is broadcast.

"RESIZE" # Fired when the window is resized

Each event gives a dictionary with the following information:

{ # All values are referencing the window
    "width": int,
    "height": int,
    "old_width": int,
    "old_height": int
}

Camera Events

There is 1 camera event that is broadcast.

"ZOOM" # Fired when the camera zoom changes

No additional information is given.

System Events

There is 1 system event that is broadcast

"EXIT" # Fires right before the program exit

No additional information is given.