Full API Documentation#

This page describes all user-accessible API components to the rubato project.

init(name='Untitled Rubato App', res=Vector(1080, 1080), window_size=None, window_pos=None, icon='', fullscreen='off', target_fps=0, physics_fps=30, hidden=False)[source]#

Initializes rubato.

Parameters:

name (str) – The title that appears at the top of the window. Defaults to “Untitled Rubato App”.
res (Vector) – The pixel resolution of the game, cast to int Vector. Defaults to Vector(1080, 1080).
window_size (Optional[Vector]) – The size of the window, cast to int Vector. When not set, defaults to half the resolution. This is usually the sweet spot between performance and image quality.
window_pos (Optional[Vector]) – The position of the window, cast to int Vector. Set to None to let the computer decide. Defaults to None.
icon (str) – The path to the icon that will appear in the window. Defaults to “” (the rubato logo).
fullscreen (Literal[‘off’, ‘desktop’, ‘exclusive’]) – Whether the game should be fullscreen. Can be one of “off”, “desktop”, or “exclusive”. Defaults to “off”.
target_fps (int) – The target frames per second. If set to 0, the target fps will be uncapped. Defaults to 0.
physics_fps (int) – The physics simulation’s frames per second. Defaults to 60.
hidden (bool) – Whether or not the window should be hidden. CANNOT BE CHANGED AFTER INIT CALL. Defaults to False.

begin()[source]#

Starts the main game loop.

Raises:: RuntimeError – rubato has not been initialized before calling.

Game#

The main game module. It controls everything in the game.

class GameProperties[source]#

Bases: type

Defines static property methods for Game.

Warning

This is only a metaclass for the class below it, so you wont be able to access this class. To use the property methods here, simply access them as you would any other Game property.

property state: int#

The state of the game.

The game states are:

Game.RUNNING
Game.STOPPED
Game.PAUSED

Return type:: int

property camera: Camera#

A shortcut getter allowing easy access to the current camera. This is a get-only property.

Note

Returns a pointer to the current camera object. This is so you can access/change the current camera properties faster, but you’d still need to use Game.current.camera to access the camera directly.

Returns:: The current scene’s camera
Return type:: Camera

class Game[source]#

Bases: object

The main game class.

name#

The title of the game window.

Type:: str

debug#

Whether to use debug-mode.

Type:: bool

show_fps#

Whether to show fps.

Type:: bool

debug_font#

What font to draw debug text in.

Type:: Font

class property current: Scene#

The current scene. Get-only.

Return type:: Scene
Returns:: The current scene.

classmethod set_scene(scene_id)[source]#

Changes the current scene. Takes effect on the next frame.

Parameters:: scene_id (str) – The id of the new scene.

classmethod quit()[source]#: Quit the game and close the python process.

classmethod start()[source]#: Starts the main game loop. Called automatically by rubato.begin().

classmethod loop()[source]#: Rubato’s main game loop. Called automatically by rubato.Game.start().

static update()[source]#: An overrideable method for updating the game. Called once per frame, before the current scene updates.

static draw()[source]#: An overrideable method for drawing the game. Called once per frame, after the current scene draws.

Scenes and Their Management#

Scenes holds two Groups. It also manages a Camera. Scenes are used to compartmentalize code. For example, you could have each level of your game on a different scene. Then to switch levels you would switch scenes.

Groups hold a collection of Game Objects and/or other Groups. Their main purpose is to further compartmentalize items. For example, items in 2 different groups won’t collide with each other. In this tutorial, we won’t be using Groups as we don’t need this functionality here.

Scene#

The Scene class which is a collection of groups. It also houses the current scene camera. Scenes are built with a root group that everything is added to.

class Scene(name=None, background_color=Color(255, 255, 255), border_color=Color())[source]#

Bases: object

A scene is a collection of groups.

Parameters:

name (Optional[str]) – The name of the scene. This is used to reference the scene. Automatically set if not assigned. Once this is set, it cannot be changed.
background_color (Color) – The color of the background of the window. Defaults to Color(255, 255, 255).
border_color (Color) – The color of the border of the window. Defaults to Color(0, 0, 0).

root#

The base group of game objects in the scene.

Type:: Group

ui#

The ui elements of this scene. These are drawn on top of everything else and do not interact with the other game objects.

Type:: Group

camera#

The camera of this scene.

Type:: Camera

border_color#: The color of the border of the window.

background_color#: The color of the background of the window.

property name: str#

The name of this scene. Read-only.

Return type:: str

switch()[source]#: Switches to this scene on the next frame.

add(*items)[source]#

Adds an item to the root group.

Parameters:: *items – The items to add to the scene.

add_ui(*items)[source]#

Adds Game Objects as UI to the scene. When a game object is added as a UI, they draw as they normally would, but they don’t collide with other game objects, they draw on top of everything else, and they are unaffected by the camera.

Parameters:: *items – The items to add to the scene.

delete(item)[source]#

Removes an item from the root group.

Parameters:: item (UnionType[GameObject, Group]) – The item to remove.

delete_ui(item)[source]#

Removes an item from the ui group.

Parameters:: item (GameObject) – The item to remove.

clone()[source]#

Clones this scene.

Warning

This is a relatively expensive operation as it clones every group in the scene.

Return type:: Scene

setup()[source]#: The start loop for this scene. It is run before the first frame. Is empty be default and can be overriden.

draw()[source]#: The draw loop for this scene. It is run once every frame. Is empty by default an can beoverridden.

update()[source]#: The update loop for this scene. It is run once every frame, before draw(). Is empty by default an can be overridden.

fixed_update()[source]#: The fixed update loop for this scene. It is run (potentially) many times a frame. Is empty by default an can be overridden.

Note

You should define fixed_update only for high priority calculations that need to match the physics fps.

paused_update()[source]#: The paused update loop for this scene. It is run once a frame when the game is paused. Is empty by default an can be overridden.

Camera#

The Camera module handles where things are drawn. A camera can zoom, pan, and travel along the z-index. Items only render if their z-index is not more than that of the camera’s.

The current scene’s camera can be accessed through Game.camera.

class Camera(pos=None, zoom=1, z_index=Math.INF)[source]#

Bases: object

The camera class.

Parameters:

pos (Optional[Vector]) – The position of the camera. Defaults to center of Display.
zoom (float) – The zoom of the camera.
z_index (int) – The z-index of the camera.

z_index#

The current z_index of the camera.

Type:: int

pos#

The current position of the camera. Center based i.e. where the camera is looking at.

Type:: Vector

property zoom: float#

The zoom value of the camera.

Return type:: float

transform(point)[source]#

World space coordinates to Screen space coordinates.

Parameters:: point (Vector) – The point to transform (world space).
Returns:: The translated coordinates.
Return type:: Vector

i_transform(point)[source]#

Inverts the transform process, screen space coordinates to world space coordinates.

Parameters:: point (Vector) – The point to transform (screen space).
Returns:: The translated coordinates.
Return type:: Vector

scale(dimension)[source]#

Scales a given dimension by the camera zoom.

Parameters:: dimension (Any) – The dimension to scale. Can be a scalar or a Vector.
Returns:: The scaled dimension.
Return type:: Any

Group#

Groups contain game objects or other groups and allow separation between game objects.

class Group(name='', active=True)[source]#

Bases: object

The group class implementation.

Parameters:

name (str) – The name of the group. Defaults to “” and is set to “Group #” when it is added to another Group or Scene.
active (bool) – Whether the group is active or not. Defaults to True.

name#

The name of the group.

Type:: str

active#

Whether the group is active or not.

Type:: bool

groups#

A list of groups that are children of this group.

Type:: List[Group]

game_objects#

A list of game objects that are children of this group.

Type:: List[GameObject]

add(*items)[source]#

Adds an item to the group.

Parameters:

items (UnionType[GameObject, Group]) – The item(s) you wish to add to the group

Raises:

Error – The item being added is already in the group.
ValueError – The group can only hold game objects or other groups.

Returns:

This group.

Return type:

Group

add_group(g)[source]#: Add a group to the group.

add_game_obj(g)[source]#: Add a game object to the group

delete(item)[source]#

Removes an item from the group.

Parameters:: item (UnionType[GameObject, Group]) – The item to remove from the group.

Note

The actually game object is not deleted, just removed from the group.

Raises:: ValueError – The item is not in the group and cannot be deleted.

fixed_update()[source]#: Runs a physics iteration on the group. Called automatically by rubato as long as the group is added to a scene.

count()[source]#: Counts all the GameObjects and subgroups in this group. :returns: The total number of GameObjects and subgroups contained in this group. :rtype: int

clone()[source]#

Clones the group and all of its children.

Warning

This is a relatively expensive operation as it clones every game object and component in the group.

Return type:: Group

contains(other)[source]#

Checks if the group contains the given object.

Parameters:: other (UnionType[GameObject, Group]) – The object to check for.
Returns:: Whether the group contains the object or not.
Return type:: bool

Game Object and Components#

Game Objects are the main item in a game. They hold Components, have a position, and have a z-index. By themselves, they have very little functionality.

Components are how Game Objects get their functionality. Each component adds or changes something about the Game Object. For example, an Image component draws an image from your filesystem to the game at the Game Object’s position.

Game Object#

A game object is a basic element that holds components, postion, and z_index.

class GameObject(name='', pos=Vector(), rotation=0, z_index=0, debug=False)[source]#

Bases: object

The base game object class.

Parameters:

name (str) – The name of the game object. Defaults to “”.
pos (Vector) – The position of the game object. Defaults to Vector(0, 0).
rotation (float) – The rotation of the game object. Defaults to 0.
z_index (int) – The z-index of the game object. Defaults to 0.
debug (bool) – Whether or not to draw the center of the game object. Defaults to False.

name#

The name of the game object. Will default to: “Game Object {number in group}”

Type:: str

pos#

The current position of the game object.

Type:: Vector

z_index#

The z_index of the game object.

Type:: int

rotation#

The rotation of the game object in degrees.

Type:: float

debug#

Whether or not to draw a debug crosshair for the game object.

Type:: bool

add(*components)[source]#

Add a component to the game object.

Parameters:: components (Component) – The component(s) to add.
Raises:: DuplicateComponentError – Raised when there is already a component of the same type on the game object.
Returns:: This GameObject.
Return type:: GameObject

remove(comp_type)[source]#

Removes a component from the game object.

Parameters:: comp_type (Type[TypeVar(T)]) – The type of the component to remove.
Raises:: Warning – The component was not in the game object and nothing was removed.

remove_all(comp_type)[source]#

Removes all components of a type from the game object.

Parameters:: comp_type (Type[TypeVar(T)]) – The type of the component to remove.
Raises:: Warning – The components were not in the game object and nothing was removed.

get(comp_type)[source]#

Gets a component from the game object.

Parameters:: comp_type (Type[TypeVar(T)]) – The type of the component to search for.
Return type:: Optional[TypeVar(T)]
Returns:: The component if it was found or None if it wasn’t.

get_all(comp_type)[source]#

Gets all the components of a type from the game object.

Parameters:

comp_type (Type[TypeVar(T)]) – The type of component to search for.

Return type:

List[TypeVar(T)]

Returns:

A list containing all the components of that type. If no components were found, the: list is empty.

delete()[source]#: Deletes and frees everything from the game object. This is called when you remove it from a group or scene.

Warning

Calling this will render the gameobject useless in the future.

clone()[source]#

Clones the game object.

Return type:: GameObject

Components#

The default Component class.

The component module that represents the template for all components.

Attention

Each component can only be attached to one game object. To add one component to multiple game objects, use the clone() method.

class Component(offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: object

A component adds functionality to the game object it is attached to. Note that this is a template class and should not be used directly. Instead create another class and extend from this one.

Parameters:

offset (Vector) – The offset of the component from the game object. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the component from the game object. Defaults to 0.
z_index (int) – The vertical offset of where to draw the component. Defaults to 0.

gameobj#

The game object this component is attached to.

Type:: GameObject

singular#

Whether multiple components of the same type are allowed on a game object.

Type:: bool

offset#

The offset from the center of the game object that the hitbox should be placed.

Type:: Vector

rot_offset#

The rotational offset from the game object’s rotation.

Type:: float

z_index#

Where to draw the component in the z direction.

Type:: int

started#

Whether the component has run its setup method.

Type:: bool

hidden#

Whether the component should not draw.

Type:: bool

property true_z#: The z_index of the component offset by its parent gameobject z_index.

draw(camera)[source]#: The draw function template for a component subclass.

update()[source]#: The update function template for a component subclass.

setup()[source]#: The setup function template for a component subclass.

fixed_update()[source]#: The physics function template for a component subclass.

delete()[source]#: The delete function template for a component subclass.

clone()[source]#

Clones the component.

Return type:: Component

Image#

The image component that renders an image from the filesystem.

class Image(rel_path, scale=Vector(1, 1), anti_aliasing=False, flipx=False, flipy=False, offset=Vector(0, 0), rot_offset=0, z_index=0)[source]#

Bases: Component

A component that handles Images.

Parameters:

rel_path (str) – The relative path to the image. Defaults to “”.
scale (Vector) – The scale of the image. Defaults to Vector(1, 1).
anti_aliasing (bool) – Whether or not to use anti-aliasing. Defaults to False.
flipx (bool) – Whether or not to flip the image horizontally. Defaults to False.
flipy (bool) – Whether or not to flip the image vertically. Defaults to False.
offset (Vector) – The offset of the image from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the image. Defaults to 0.
z_index (int) – The z-index of the image. Defaults to 0.

property image: sdl2.SDL_Surface#

The SDL Surface of the image.

Return type:: SDL_Surface

property scale: Vector#

The scale of the image.

Return type:: Vector

property rot_offset: float#

The rotation offset of the image.

Return type:: float

property flipx: bool#

Whether or not the image is flipped horizontally.

Return type:: bool

property flipy: bool#

Whether or not the image is flipped vertically.

Return type:: bool

property aa: bool#

Whether or not the image is anti-aliased.

Return type:: bool

get_rect()[source]#

Generates the rectangular bounding box of the image.

Return type:: Rectangle
Returns:: The Rectangle hitbox that bounds the image.

get_size()[source]#

Gets the current size of the image.

Return type:: Vector
Returns:: The size of the image

get_size_original()[source]#

Gets the original size of the image.

Returns:: The original size of the image.
Return type:: Vector

resize(new_size)[source]#

Resize the image to a given size in pixels.

Parameters:: new_size (Vector) – The new size of the image in pixels.

update()[source]#: The update function template for a component subclass.

draw(camera)[source]#: The draw function template for a component subclass.

delete()[source]#: Deletes the image component

clone()[source]#

Clones the current image.

Returns:: The cloned image.
Return type:: Image

Raster#

A Raster is a grid of pixels that you can draw shapes onto or edit individual pixels.

class Raster(width=32, height=32, scale=Vector(1, 1), offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

A raster area for drawings. Rasters are used to draw shapes and manipulate individual pixels. Once a rasters size is set, it cannot be changed. You can however change the scale and rotation of the raster.

Parameters:

width (int) – The width of the raster. Defaults to 32.
height (int) – The height of the raster. Defaults to 32.
offset (Vector) – The offset of the raster from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the raster from the gameobject. Defaults to 0.
scale (Vector) – The scale of the raster. Defaults to Vector(1, 1).

property raster: sdl2.SDL_Surface#

The raster surface.

Return type:: SDL_Surface

property width: int#

The height of the raster in pixels.

Return type:: int

property height: int#

The width of the raster in pixels.

Return type:: int

property rendered_size: Vector#

The size of the raster after scaling (ie. the size it will be rendered at).

Return type:: Vector

property scale: Vector#

The scale of the raster.

Return type:: Vector

property rot_offset: float#

The rotation offset of the raster.

Return type:: float

draw_point(pos, color=Color.black)[source]#

Draws a point on the image.

Parameters:

pos (Vector) – The position to draw the point.
color (Color) – The color of the point. Defaults to black.

draw_line(start, end, color=Color.black, width=1)[source]#

Draws a line on the image.

Parameters:

start (Vector) – The start of the line.
end (Vector) – The end of the line.
color (Color) – The color of the line. Defaults to black.
width (int) – The width of the line. Defaults to 1.

draw_rect(top_left, bottom_right, color=Color.black, width=1)[source]#: Draws a rectangle border on the image. :type top_left: Vector :param top_left: The top left corner of the rectangle. :type bottom_right: Vector :param bottom_right: The bottom right corner of the rectangle. :type color: Color :param color: The color of the rectangle. Defaults to black. :type width: int :param width: Width of the rectangle border. Defaults to 1.

get_pixel(pos)[source]#

Gets the color of a pixel on the image.

Parameters:: pos (Vector) – The position of the pixel.
Returns:: The color of the pixel.
Return type:: Color

get_pixel_tuple(pos)[source]#

Gets the color of a pixel on the image.

Parameters:: pos (Tuple[UnionType[int, float], UnionType[int, float]]) – The position of the pixel.
Return type:: Tuple[UnionType[int, float], UnionType[int, float], UnionType[int, float], UnionType[int, float]]
Returns:: The color of the pixel.

set_pixel(pos, color)[source]#

Sets the color of a pixel on the image.

Parameters:

pos (Vector) – The position of the pixel.
color (Color) – The color of the pixel.

switch_color(color, new_color)[source]#

Switches a color in the image.

Parameters:

color (Color) – The color to switch.
new_color (Color) – The new color to switch to.

set_colorkey(color)[source]#: Sets the colorkey of the image. :type color: Color :param color: Color to set as the colorkey.

cam_update(info)[source]#: Updates the raster size when the camera zoom changes

draw(camera)[source]#: The draw function template for a component subclass.

Text#

A text component.

class Text(text='', font=Font(), justify='left', anchor=Vector(0, 0), width=0, offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

A text component subclass. Add this to game objects or UI elements to give them text.

Parameters:

text (str) – The text to display. Defaults to “”.
font (Font) – The font to use. Defaults to Font().
justify (Literal[‘left’, ‘center’, ‘right’]) – The justification of the text. Defaults to “left”.
anchor (Vector) – The anchor of the text. The zero vector means it is centered. x component is whether to shift left, none, or right (-1, 0, 1). y component is whether to shift top, none, or bottom (-1, 0, 1). Defaults to Vector(0, 0).
width (int) – The width of the text. Defaults to 0.
offset (Vector) – The offset of the text from the game object. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the text from the game object. Defaults to 0.
z_index (int) – The z index of the text. Defaults to 0.

property text: str#

The text of the Text.

Return type:: str

property justify: str#

The justification of the text.

Can be one of: "left", "center", "right".

Return type:: str

property anchor: Vector#

The anchor vector of the text.

This controls the position of the text relative to the game object. Is a vector where the x value controls the x anchor and the y value controls the y anchor. The values for each can be either -1, 0 or 1. This offset the text around the game object center.

Example

An anchor of Vector(0, 0) will center the text on the game object. An anchor of Vector(1, 1) will move the text so that it’s top left corner is at the game object’s center.

Warning

Previously was called align.

Return type:: Vector

property width: int#

The maximum width of the text. Will automatically wrap the text. Use -1 to disable wrapping.

Return type:: int

property font_object: Font#

The font object of the text.

Return type:: Font

property font_size: int#

The font size.

Warning

Don’t set this too high or font smoothing may misbehave on some systems.

Return type:: int

property font_color: Color#

The font color.

Return type:: Color

add_style(style)[source]#: Add a style to the font (bold, italic, underline, strikethrough, normal).

remove_style(style)[source]#: Remove a style from a font.

generate_surface()[source]#: (Re)generates the surface of the text.

draw(camera)[source]#: The draw function template for a component subclass.

delete()[source]#: Deletes the text component.

clone()[source]#

Clones the text component.

Return type:: Text

Button#

A button component that can be used in UI or to detect mouse presses in an area.

class Button(width=10, height=10, onclick=None, onrelease=None, onhover=None, onexit=None, offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

A Button component. Add this to game objects or UI elements to give them clickable areas.

Parameters:

width (int) – The width of the button. Defaults to 10.
height (int) – The height of the button. Defaults to 10.
onclick (Optional[Callable]) – The function to call when the button is clicked. Defaults to lambda: None.
onrelease (Optional[Callable]) – The function to call when the button is released. Defaults to lambda: None.
onhover (Optional[Callable]) – The function to call when the mouse enters the button. Defaults to lambda: None.
onexit (Optional[Callable]) – The function to call when the mouse exits the button. Defaults to lambda: None.
offset (Vector) – The offset of the button from the game object. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the button from the game object. Defaults to 0.
z_index (int) – The z-index of the button. Defaults to 0.

pressed#

Whether the button is currently pressed.

Type:: bool

hover#

Whether the mouse is hovering over the button.

Type:: bool

dims#

The dimensions of the button.

Type:: Vector

onclick#

The function to call when the button is clicked.

Type:: Callable

onrelease#

The function to call when the button is released.

Type:: Callable

onhover#

The function to call when the mouse enters the button.

Type:: Callable

onexit#

The function to call when the mouse exits the button.

Type:: Callable

update()[source]#: The update function for buttons.

clone()[source]#

Clones the component.

Return type:: Button

Slider#

A slider component that can be used in UI.

class Slider(button_width=10, button_height=10, slider_length=10, slider_direction=Vector(0, -1), onclick=None, onrelease=None, onhover=None, onexit=None, offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

A Slider component. Still needs to be added to a GameObject.

Parameters:

button_width (int) – The width of the clickable area. Defaults to 10.
button_height (int) – The height of the clickable area. Defaults to 10.
slider_length (int) – The length of the slider. Defaults to 10.
slider_direction (Vector) – The direction of the slider. Defaults to Vector(0, -1).
onclick (Optional[Callable]) – The function to call when the button is clicked. Defaults to lambda: None.
onrelease (Optional[Callable]) – The function to call when the button is released. Defaults to lambda: None.
onhover (Optional[Callable]) – The function to call when the mouse enters the button. Defaults to lambda: None.
onexit (Optional[Callable]) – The function to call when the mouse exits the button. Defaults to lambda: None.
offset (Vector) – The offset of the component from the game object. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the component from the game object. Defaults to 0.
z_index (int) – The z-index of the component. Defaults to 0.

pressed#

Whether the button is currently pressed.

Type:: bool

hover#

Whether the mouse is hovering over the button.

Type:: bool

dims#

The dimensions of the button.

Type:: Vector

onclick#

The function to call when the button is clicked.

Type:: Callable

onrelease#

The function to call when the button is released.

Type:: Callable

onhover#

The function to call when the mouse enters the button.

Type:: Callable

onexit#

The function to call when the mouse exits the button.

Type:: Callable

slider_length#

The length of the slider.

Type:: int

slider_direction#

The direction of the slider.

Type:: Vector

button#

The button component.

Type:: Button

update()[source]#: The update function for buttons.

draw(camera)[source]#: The draw function for buttons.

Animation#

This is the animation component module for game objects.

class Animation(scale=Vector(1, 1), fps=24, anti_aliasing=False, flipx=False, flipy=False, offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

Animations are a series of images that update automatically in accordance with parameters.

Parameters:

scale (Vector) – The scale of the animation. Defaults to Vector(1, 1).
fps (int) – The frames per second of the animation. Defaults to 24.
anti_aliasing (bool) – Whether to use anti-aliasing on the animation. Defaults to False.
flipx (bool) – Whether to flip the animation horizontally. Defaults to False.
flipy (bool) – Whether to flip the animation vertically. Defaults to False.
offset (Vector) – The offset of the animation from the game object. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the animation from the game object. Defaults to 0.
z_index (int) – The z-index of the animation. Defaults to 0.

default_state#

The key of the default state. Defaults to None.

Type:: Optional[str]

current_state#

The key of the current state. Defaults to “”.

Type:: str

animation_frames_left#

The number of animation frames left.

Type:: int

loop#

Whether the animation should loop. Defaults to False.

Type:: bool

aa#

Whether or not to enable anti aliasing.

Type:: bool

flipx#

Whether or not to flip the animation along the x axis.

Type:: bool

flipy#

Whether or not to flip the animation along the y axis.

Type:: bool

property fps#: The fps of the animation.

property current_frame: int#

The current frame that the animation is on.

Return type:: int

property image: sdl2.surface.SDL_Surface#

The current SDL Surface holding the image.

Return type:: SDL_Surface

property anim_frame: Sprite#

The current animation frame.

Return type:: Sprite

set_current_state(new_state, loop=False, freeze=-1)[source]#

Set the current animation state.

Parameters:

new_state (str) – The key of the new current state.
loop (bool) – Whether to loop the state. Defaults to False.
freeze (int) – Freezes the animation once the specified frame is reached (No animation). Use -1 to never freeze. Defaults to -1.

Raises:

KeyError – The new_state key is not in the initialized states.

resize(new_size)[source]#

Resize the Animation to a given size in pixels.

Parameters:: new_size (Vector) – The new size of the Animation in pixels.

reset()[source]#: Reset the animation state back to the first frame.

add(state_name, images)[source]#

Adds a state to the animation.

Parameters:

state_name (str) – The key used to reference this state.
images (List[Sprite]) – A list of images to use as the animation.

add_folder(state_name, rel_path, recursive=True)[source]#

Adds a state from a folder of images. Directory must be solely comprised of images.

Parameters:

state_name (str) – The key used to reference this state.
rel_path (str) – The relative path to the folder you wish to import
recursive (bool) – Whether it will import an animation shallowly or recursively. Defaults to True.

add_spritesheet(state_name, spritesheet, from_coord=Vector(), to_coord=Vector())[source]#

Adds a state from a spritesheet. Will include all sprites from the from_coord to the to_coord.

Parameters:

state_name (str) – The key used to reference this state.
spritesheet (Spritesheet) – The spritesheet to use.
from_coord (Vector) – The grid coordinate of the first frame. Defaults to Vector().
to_coord (Vector) – The grid coordinate of the last coord. Defaults to Vector().

Example

animation.add_spritesheet("idle", spritesheet, Vector(0, 0), Vector(1, 3))
# This will add the frames (0, 0) to (0, size) and (1, 0) to (1, 3) inclusive to the animation
# with the state name "idle".

animation.add_spritesheet("idle", spritesheet, to_coord=spritesheet.end)
# This will just load from the start to the end of the spritesheet.

setup()[source]#: Sets up the animation component.

update()[source]#: The update function template for a component subclass.

draw(camera)[source]#: Draws the animation frame and steps the animation forward.

anim_tick()[source]#: An animation processing tick.

delete()[source]#: Deletes the animation component

clone()[source]#

Clones the animation.

Return type:: Animation

Spritesheet#

A module to load, manage, and interact with spritesheets.

class Spritesheet(rel_path, sprite_size=Vector(32, 32), grid_size=None)[source]#

Bases: object

A spritesheet from the filesystem.

Parameters:

rel_path (str) – The relative path to the spritesheet.
sprite_size (Vector) – The size of each sprite in the spritesheet. Defaults to Vector(32, 32).
grid_size (Optional[Vector]) – The size of the grid of sprites in the spritesheet. Set to None to automatically determine the grid size. Defaults to None.

Raises:

IndexError – If user does not load the entire sheet.

property grid_size: Vector#

The size of the spritesheet grid (readonly).

Return type:: Vector

property sprite_size: Vector#

The size of each sprite (readonly).

Return type:: Vector

property sheet: Sprite#

The actual spritesheet sprite (readonly).

Return type:: Sprite

property sprites: List[List[Sprite]]#

The list of all the sprites as sprites (readonly).

Return type:: List[List[Sprite]]

property end#: The end indexes of the Spritesheet as a vector.

Example

You can use spritesheet.get(*spritesheet.end) to get the final Sprite

get(x, y)[source]#

Gets the Sprite at the corresponding grid coordinate of the spritesheet.

Parameters:

x (int) – The x grid coordinate.
y (int) – The y grid coordinate.

Raises:

IndexError – One or both of the coordinates are out of range of the spritesheet’s size.

Return type:

Sprite

Returns:

The Sprite at the corresponding coordinate.

static from_folder(rel_path, sprite_size, default_state=None, recursive=True)[source]#

Creates an Animation from a folder of spritesheets. Directory must be comprised solely of spritesheets. Added alphabetically. Default is the first sheet loaded.

Parameters:

rel_path (str) – The relative path to the folder you wish to import
sprite_size (Vector) – The size of a single sprite in your spritesheet, should be the same in all imported sheets.
default_state – Sets the default state of the animation.
recursive (bool) – Whether it will import an animation shallowly or recursively. Defaults to True.

Returns:

the animation loaded from the folder of spritesheets

Return type:

Animation

Hitbox#

Various hitbox components that enable collisions

class Hitbox(color=None, tag='', debug=False, trigger=False, scale=1, on_collide=None, on_exit=None, offset=Vector(0, 0), rot_offset=0, z_index=0)[source]#

Bases: Component

A hitbox superclass. Do not use this class to attach hitboxes to your game objects. Instead, use Polygon, Rectangle, or Circle, which inherit Hitbox properties.

Parameters:

color (Optional[Color]) – The color of the hitbox. Set to None to not show the hitbox. Defaults to None.
tag (str) – A string to tag the hitbox. Defaults to “”.
debug (bool) – Whether or not to draw the hitbox. Defaults to False.
trigger (bool) – Whether or not the hitbox is a trigger. Defaults to False.
scale (int) – The scale of the hitbox. Defaults to 1.
on_collide (Optional[Callable]) – A function to call when the hitbox collides with another hitbox. Defaults to lambda manifold: None.
on_exit (Optional[Callable]) – A function to call when the hitbox exits another hitbox. Defaults to lambda manifold: None.
offset (Vector) – The offset of the hitbox from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the hitbox. Defaults to 0.
z_index (int) – The z-index of the hitbox. Defaults to 0.

tag#

The tag of the hitbox (can be used to identify hitboxes in collision callbacks)

Type:: str

debug#

Whether to draw a green outline around the hitbox or not.

Type:: bool

trigger#

Whether this hitbox is just a trigger or not.

Type:: bool

scale#

The scale of the hitbox

Type:: int

on_collide#

The on_collide function to call when a collision happens with this hitbox.

Type:: Callable

on_exit#

The on_exit function to call when a collision ends with this hitbox.

Type:: Callable

color#

Type:: Color

colliding#

An unordered set of hitboxes that the Hitbox is currently colliding with.

Type:: Set[Hitbox]

property pos: Vector#

The getter method for the position of the hitbox’s center

Return type:: Vector

get_aabb()[source]#

Gets top left and bottom right corners of the axis-aligned bounding box of the hitbox in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

get_obb()[source]#

Gets the top left and bottom right corners of the oriented bounding box in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

Rectangle#

class Rectangle(width=10, height=10, color=None, tag='', debug=False, trigger=False, scale=1, on_collide=None, on_exit=None, offset=Vector(0, 0), rot_offset=0, z_index=0)[source]#

Bases: Hitbox

A rectangle implementation of the Hitbox subclass.

Parameters:

width (int) – The width of the rectangle. Defaults to 10.
height (int) – The height of the rectangle. Defaults to 10.
color (Optional[Color]) – The color of the hitbox. Set to None to not show the hitbox. Defaults to None.
tag (str) – A string to tag the hitbox. Defaults to “”.
debug (bool) – Whether or not to draw the hitbox. Defaults to False.
trigger (bool) – Whether or not the hitbox is a trigger. Defaults to False.
scale (int) – The scale of the hitbox. Defaults to 1.
on_collide (Optional[Callable]) – A function to call when the hitbox collides with another hitbox. Defaults to lambda manifold: None.
on_exit (Optional[Callable]) – A function to call when the hitbox exits another hitbox. Defaults to lambda manifold: None.
offset (Vector) – The offset of the hitbox from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the hitbox. Defaults to 0.
z_index (int) – The z-index of the hitbox. Defaults to 0.

width#

The width of the rectangle.

Type:: int

height#

The height of the rectangle.

Type:: int

property top_left#: The top left corner of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property bottom_left#: The bottom left corner of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property top_right#: The top right corner of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property bottom_right#: The bottom right corner of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property top#: The top side of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property left#: The bottom side of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property bottom#: The bottom side of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property right#: The right side of the rectangle.

Note

This can only be accessed and set after the Rectangle has been added to a Game Object.

property radius: float#

The radius of the rectangle.

Return type:: float

contains_pt(pt)[source]#

Checks if a point is inside the Rectangle.

Parameters:: pt (Vector) – The point to check, in game-world coordinates.
Returns:: Whether or not the point is inside the Rectangle.
Return type:: bool

get_aabb()[source]#

Gets top left and bottom right corners of the axis-aligned bounding box of the hitbox in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

get_obb()[source]#

Gets the top left and bottom right corners of the oriented bounding box in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

vertices()[source]#

Generates a list of the rectangle’s vertices with no transformations applied.

Returns:: The list of vertices. Top left, top right, bottom right, bottom left.
Return type:: List[Vector]

translated_verts()[source]#

Offsets each vertex with the Polygon’s offset. Top left, top right, bottom right, bottom left.

Returns:: The list of vertices.
Return type:: List[Vector]

transformed_verts()[source]#

Generates a list of the rectangle’s vertices, scaled and rotated.

Returns:: The list of vertices. Top left, top right, bottom right, bottom left.
Return type:: List[Vector]

real_verts()[source]#

Generates a list of the rectangle’s vertices, relative to its position.

Returns:: The list of vertices. Top left, top right, bottom right, bottom left.
Return type:: List[Vector]

draw(camera)[source]#: Will draw the rectangle to the screen. Won’t draw if color = None.

clone()[source]#

Clones the component.

Return type:: Rectangle

Polygon#

class Polygon(verts=[], color=None, tag='', debug=False, trigger=False, scale=1, on_collide=None, on_exit=None, offset=Vector(0, 0), rot_offset=0, z_index=0)[source]#

Bases: Hitbox

A polygon Hitbox implementation. Supports an arbitrary number of custom vertices, as long as the polygon is convex.

Danger

If generating vertices by hand, make sure you generate them in a counter-clockwise direction. Otherwise, polygons will neither behave nor draw properly.

Warning

rubato does not currently support concave polygons explicitly. Creating concave polygons will result in undesired collision behavior. However, you can still use concave polygons in your projects: Simply break them up into multiple convex Polygon hitboxes and add them individually to a gameobject.

Parameters:

verts (List[Vector]) – The vertices of the polygon. Defaults to [].
color (Optional[Color]) – The color of the hitbox. Set to None to not show the hitbox. Defaults to None.
tag (str) – A string to tag the hitbox. Defaults to “”.
debug (bool) – Whether or not to draw the hitbox. Defaults to False.
trigger (bool) – Whether or not the hitbox is a trigger. Defaults to False.
scale (int) – The scale of the hitbox. Defaults to 1.
on_collide (Optional[Callable]) – A function to call when the hitbox collides with another hitbox. Defaults to lambda manifold: None.
on_exit (Optional[Callable]) – A function to call when the hitbox exits another hitbox. Defaults to lambda manifold: None.
offset (Vector) – The offset of the hitbox from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the hitbox. Defaults to 0.
z_index (int) – The z-index of the hitbox. Defaults to 0.

verts#

A list of the vertices in the Polygon, in anticlockwise direction.

Type:: List[Vector]

property radius: float#

The radius of the Polygon

Return type:: float

clone()[source]#

Clones the Polygon

Return type:: Polygon

get_aabb()[source]#

Gets top left and bottom right corners of the axis-aligned bounding box of the hitbox in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

get_obb()[source]#

Gets the top left and bottom right corners of the oriented bounding box in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

translated_verts()[source]#

Offsets each vertex with the Polygon’s offset

Return type:: List[Vector]

transformed_verts()[source]#

Maps each vertex with the Polygon’s scale and rotation

Return type:: List[Vector]

real_verts()[source]#

Returns the a list of vertices in world coordinates

Return type:: List[Vector]

contains_pt(pt)[source]#

Checks if a point is inside the Polygon.

Parameters:: pt (Vector) – The point to check, in game-world coordinates..
Returns:: Whether or not the point is inside the Polygon.
Return type:: bool

draw(camera)[source]#: The draw function template for a component subclass.

classmethod generate_polygon(num_sides, radius=1)[source]#

Generates the vertices of a regular polygon with a specified number of sides and a radius. You can use this as the verts option in the Polygon constructor if you wish to generate a regular polygon.

Parameters:

num_sides (int) – The number of sides of the polygon.
radius (UnionType[float, int]) – The radius of the polygon. Defaults to 1.

Raises:

SideError – Raised when the number of sides is less than 3.

Return type:

List[Vector]

Returns:

The vertices of the polygon.

Circle#

class Circle(radius=10, color=None, tag='', debug=False, trigger=False, scale=1, on_collide=None, on_exit=None, offset=Vector(0, 0), rot_offset=0, z_index=0)[source]#

Bases: Hitbox

A circle Hitbox subclass defined by a position, radius, and scale.

Parameters:

radius (int) – The radius of the circle. Defaults to 10.
color (Optional[Color]) – The color of the hitbox. Set to None to not show the hitbox. Defaults to None.
tag (str) – A string to tag the hitbox. Defaults to “”.
debug (bool) – Whether or not to draw the hitbox. Defaults to False.
trigger (bool) – Whether or not the hitbox is a trigger. Defaults to False.
scale (int) – The scale of the hitbox. Defaults to 1.
on_collide (Optional[Callable]) – A function to call when the hitbox collides with another hitbox. Defaults to lambda manifold: None.
on_exit (Optional[Callable]) – A function to call when the hitbox exits another hitbox. Defaults to lambda manifold: None.
offset (Vector) – The offset of the hitbox from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The rotation offset of the hitbox. Defaults to 0.
z_index (int) – The z-index of the hitbox. Defaults to 0.

radius#

The radius of the circle.

Type:: int

Note

If color is unassigned, the circle will not be drawn. And will act like a circular hitbox.

property center: Vector#

The center of the circle. Equivalent to pos

Return type:: Vector

get_aabb()[source]#

Gets top left and bottom right corners of the axis-aligned bounding box of the hitbox in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

get_obb()[source]#

Gets the top left and bottom right corners of the oriented bounding box in world coordinates.

Return type:: List[Vector]
Returns:: The top left and bottom right corners of the bounding box as Vectors in a list. [top left, bottom right]

transformed_radius()[source]#

Gets the true radius of the circle

Return type:: int

contains_pt(pt)[source]#

Checks if a point is inside the Circle.

Parameters:: pt (Vector) – The point to check, in game-world coordinates..
Returns:: Whether or not the point is inside the Circle.
Return type:: bool

draw(camera)[source]#: Will draw the circle to the screen. Won’t draw if color = None.

clone()[source]#

Clones the component.

Return type:: Circle

RigidBody#

The Rigidbody component contains an implementation of rigidbody physics. They have hitboxes and can collide and interact with other rigidbodies.

class RigidBody(mass=1, gravity=Vector(), friction=0, static=False, bounciness=0, max_speed=Vector(Math.INF, Math.INF), velocity=Vector(), ang_vel=0, pos_correction=0.25, offset=Vector(), rot_offset=0, z_index=0)[source]#

Bases: Component

A RigidBody implementation with built in physics and collisions. Rigidbodies require hitboxes.

Parameters:

mass (float) – The mass of the rigidbody. Defaults to -1.
gravity (Vector) – The gravity of the rigidbody. Defaults to Vector(0, 0).
friction (float) – The friction of the rigidbody. Defaults to 0.
static (bool) – Whether the rigidbody is static. Defaults to False.
bounciness (float) – The bounciness of the rigidbody. Defaults to 0.
max_speed (Vector) – The maximum speed of the rigidbody. Defaults to Vector(INF, INF).
velocity (Vector) – The velocity of the rigidbody. Defaults to Vector(0, 0).
ang_vel (float) – The angular velocity of the rigidbody. Defaults to 0.
pos_correction (float) – The positional correction of the rigidbody. Defaults to 0.25.
offset (Vector) – The offset of the rigidbody from the gameobject. Defaults to Vector(0, 0).
rot_offset (float) – The offset of the rigidbody’s rotation from the gameobject. Defaults to 0.
z_index (int) – The z-index of the rigidbody. Defaults to 0.

static#

Whether or not the rigidbody is static (as in, it does not move).

Type:: bool

gravity#

The acceleration of the gravity that should be applied.

Type:: Vector

friction#

The friction coefficient of the Rigidbody (usually a a value between 0 and 1).

Type:: float

max_speed#

The maximum speed of the Rigidbody.

Type:: Vector

min_speed#

The minimum speed of the Rigidbody.

Type:: Vector

velocity#

The current velocity of the Rigidbody.

Type:: Vector

ang_vel#

The current angular velocity of the Rigidbody.

Type:: float

bounciness#

How bouncy the rigidbody is (usually a value between 0 and 1).

Type:: float

advanced#

Whether to use rotational collision resolution (not desired in basic platformers, for instance).

Type:: bool

property inv_mass: float#

The inverse mass of the Rigidbody.

Return type:: float

property mass: float#

The mass of the Rigidbody.

Return type:: float

physics()[source]#: Applies general kinematic laws to the rigidbody.

add_force(force)[source]#

Applies a force to the Rigidbody.

Parameters:: force (Vector) – The force to add.

add_impulse(impulse)[source]#

Applies an impulse to the rigidbody.

Parameters:: impulse (Vector) – _description_

add_cont_force(force, time)[source]#

Add a continuous force to the Rigidbody. A continuous force is a force that is continuously applied over a time period. (the force is added every frame for a specific duration).

Parameters:

force (Vector) – The force to add.
time (int) – The time in seconds that the force should be added.

add_cont_impulse(impulse, time)[source]#

Add a continuous impulse to the Rigidbody. A continuous impulse is a impulse that is continuously applied over a time period. (the impulse is added every frame for a specific duration).

Parameters:

impulse (Vector) – The impulse to add.
time (int) – The time in seconds that the impulse should be added.

fixed_update()[source]#: The physics loop for the rigidbody component.

clone()[source]#

Clones the component.

Return type:: RigidBody

Physics#

The Engine and Manifold classes comprise rubato’s collision engine. Collision and overlap tests inside groups are automatically handled by rubato, so these classes are here mainly for reference.

In general, it is recommended that you define callback functions for Hitbox objects instead of calling Engine functions yourself.

Engine#

class Engine[source]#

Bases: object

rubato’s physics engine. Handles overlap tests for Hitboxes and resolves Rigidbody collisions.

static resolve(col)[source]#

Resolve the collision between two rigidbodies.

Parameters:: col (Manifold) – The collision information.

static overlap(hitbox_a, hitbox_b)[source]#

Determines if there is overlap between two hitboxes. Returns a Manifold manifold if a collision occurs but does not resolve.

Parameters:

hitbox_a (Hitbox) – The first hitbox to collide with.
hitbox_b (Hitbox) – The second hitbox to collide with.

Return type:

Optional[Manifold]

Returns:

Returns a collision info object if overlap is detected or None if no collision is detected.

static collide(hitbox_a, hitbox_b)[source]#

Collides two hitboxes (if they overlap), calling their callbacks if they exist. Resolves the collision using Rigidbody impulse resolution if applicable.

Parameters:

hitbox_a (Hitbox) – The first hitbox to collide with.
hitbox_b (Hitbox) – The second hitbox to collide with.

Return type:

Optional[Manifold]

Returns:

Returns a collision info object if a collision is detected or None if no collision is detected.

static circle_circle_test(circle_a, circle_b)[source]#

Checks for overlap between two circles

Return type:: Optional[Manifold]

static circle_polygon_test(circle, polygon)[source]#

Checks for overlap between a circle and a polygon

Return type:: Optional[Manifold]

static polygon_polygon_test(shape_a, shape_b)[source]#

Checks for overlap between two polygons

Return type:: Optional[Manifold]

static axis_least_penetration(a, b)[source]#

Finds the axis of least penetration between two possibly colliding polygons.

Return type:: float

static get_support(verts, direction)[source]#

Gets the furthest support vertex in a given direction.

Return type:: Vector

static get_normal(verts, index)[source]#

Finds a vector perpendicular to a side

Return type:: Vector

Manifold#

class Manifold(shape_a, shape_b, penetration=0, normal=Vector())[source]#

Bases: object

A class that represents information returned in a successful collision.

Parameters:

shape_a (Optional[Hitbox]) – The first shape involved in the collision.
shape_b (Optional[Hitbox]) – The second shape involved in the collision.
penetration (float) – The amount of penetration between the two shapes.
normal (Vector) – The normal of the collision.

shape_a#

A reference to the first shape.

Type:: Optional[Hitbox]

shape_b#

A reference to the second shape.

Type:: Optional[Hitbox]

penetration#

The amount by which the colliders are intersecting.

Type:: float

normal#

The direction that would most quickly separate the two colliders.

Type:: Vector

flip()[source]#

Flips the reference shape in a collision manifold

Return type:: Manifold
Returns:: A reference to self.

Hardware Interaction#

All of these static classes let you interact with the hardware. Either by checking for user input, drawing to the screen or playing a sound.

Display#

Global display class that allows for easy screen and window management.

class DisplayProperties[source]#

Bases: type

Defines static property methods for Display.

Attention

This is only a metaclass for the class below it, so you wont be able to access this class. To use the property methods here, simply access them as you would any other Display property.

property window_size: Vector#

The pixel size of the physical window.

Warning

Using this value to determine the placement of your game objects may lead to unexpected results. You should instead use Display.res

Return type:: Vector

property res: Vector#

The pixel resolution of the game. This is the number of virtual pixels on the window.

Example

The window (Display.window_size) could be rendered at 500x500 while the resolution is at 1000x1000. This would mean that you can place game objects at 900, 900 and still see them despite the window not being 900 pixels tall.

Warning

While this value can be changed, it is recommended that you do not alter it after initialization as it will scale your entire project in unexpected ways. If you wish to achieve scaling across an entire scene, simply utilize the camera zoom property in your scene’s camera.

Return type:: Vector

property window_pos: Vector#

The current position of the window in terms of screen pixels

Return type:: Vector

property display_ratio: Vector#

The ratio of the renderer resolution to the window size. This is a read-only property.

Returns:: The ratio of the renderer resolution to the window size seperated by x and y.
Return type:: Vector

property border_size: int#

The size of the black border on either side of the drawing area when the aspect ratios don’t match.

Return type:: int

property has_x_border: bool#

Whether or not the window has a black border on the left or right side.

Return type:: bool

property has_y_border: bool#

Whether or not the window has a black border on the top or bottom.

Return type:: bool

class Display[source]#

Bases: object

A static class that houses all of the display information

window#

The pysdl2 window element.

Type:: sdl2.Window

renderer#

The pysdl2 renderer element.

Type:: sdl2.Renderer

format#

The pysdl2 pixel format element.

Type:: sdl2.PixelFormat

classmethod set_window_icon(path)[source]#

Set the icon of the window.

Parameters:: path (str) – The path to the icon.

classmethod set_fullscreen(on=True, mode='desktop')[source]#

Set the window to fullscreen.

Parameters:

on (bool) – Whether or not to set the window to fullscreen.
mode (Literal[‘desktop’, ‘exclusive’]) – The type of fullscreen to use. Can be either “desktop” or “exclusive”.

classmethod update(tx, pos)[source]#

Update the current screen.

Parameters:

tx (Texture) – The texture to draw on the screen.
pos (Vector) – The position to draw the texture on.

classmethod clone_surface(surface)[source]#

Clones an SDL surface.

Parameters:: surface (SDL_Surface) – The surface to clone.
Returns:: The cloned surface.
Return type:: sdl2.SDL_Surface

classmethod get_window_border_size()[source]#

Get the size of the window border. pixels on the top sides and bottom of the window.

Returns:: The size of the window border.

classmethod save_screenshot(filename, path='./', extension='png', save_to_temp_path=False, quality=100)[source]#

Save the current screen to a file.

Parameters:

filename (str) – The name of the file to save to.
path (str) – Path to output folder.
extension (str) – The extension to save the file as. (png, jpg, bmp supported)
save_to_temp_path (bool) – Whether to save the file to a temporary path (i.e. MEIPASS used in exe).
quality (int) – The quality of the jpg 0-100 (only used for jpgs).

Return type:

bool

Returns:

If save was successful.

class property top_left: Vector#

The position of the top left of the window.

Return type:: Vector

class property top_right: Vector#

The position of the top right of the window.

Return type:: Vector

class property bottom_left: Vector#

The position of the bottom left of the window.

Return type:: Vector

class property bottom_right: Vector#

The position of the bottom right of the window.

Return type:: Vector

class property top_center: Vector#

The position of the top center of the window.

Return type:: Vector

class property bottom_center: Vector#

The position of the bottom center of the window.

Return type:: Vector

class property center_left: Vector#

The position of the center left of the window.

Return type:: Vector

class property center_right: Vector#

The position of the center right of the window.

Return type:: Vector

class property center: Vector#

The position of the center of the window.

Return type:: Vector

class property top: int#

The position of the top of the window.

Return type:: int

class property right: int#

The position of the right of the window.

Return type:: int

class property left: int#

The position of the left of the window.

Return type:: int

class property bottom: int#

The position of the bottom of the window.

Return type:: int

Input#

The Input module is the way you collect input from the user.

class Input[source]#

Bases: object

The input class, handling keyboard and mouse getter and setter functionality

Go here for a list of all the available keys.

classmethod key_pressed(*keys)[source]#

Checks if keys are pressed. Case insensitive.

Parameters:: *keys – The names of the keys to check.
Returns:: Whether the keys are pressed.
Return type:: bool

Example

if rb.Input.key_pressed("a"):
    # handle the "a" keypress

if rb.Input.key_pressed("shift", "w"):
    # handle the "shift+w" keypress

classmethod get_keyboard_state()[source]#: Returns a list with the current SDL keyboard state.

classmethod get_name(code)[source]#

Gets the name of a key from its keycode.

Parameters:: code (int) – A keycode.
Returns:: The corresponding key.
Return type:: str

classmethod mods_from_code(code)[source]#

Gets the modifier names from a mod code.

Parameters:: code (int) – The mod code.
Returns:: A list with the names of the currently pressed modifiers.
Return type:: List[str]

classmethod key_from_name(char)[source]#

Gets the keycode of a key from its name.

Parameters:: char (str) – The name of the key.
Returns:: The corresponding keycode.
Return type:: int

classmethod scancode_from_name(char)[source]#

Gets the scancode of a key from its name.

Parameters:: char (str) – The name of the key.
Returns:: The corresponding scancode.
Return type:: int

classmethod window_focused()[source]#

Checks if the display has keyboard focus.

Returns:: True if the window is focused, false otherwise.
Return type:: bool

classmethod mouse_state()[source]#

Checks which mouse buttons are pressed.

Returns:: A tuple with 5 booleans representing the state of each mouse button. (button1, button2, button3, button4, button5)
Return type:: Tuple[bool]

classmethod mouse_pressed()[source]#

Checks if any mouse button is pressed.

Return type:: bool
Returns:: True if any button is pressed, false otherwise.

classmethod mouse_is_pressed(cls)[source]#

Checks which mouse buttons are pressed.

Returns:: A tuple with 5 booleans representing the state of each mouse button. (button1, button2, button3, button4, button5)
Return type:: Tuple[bool]

classmethod any_mouse_button_pressed(cls)[source]#

Checks if any mouse button is pressed.

Return type:: bool
Returns:: True if any button is pressed, false otherwise.

static get_mouse_pos()[source]#

The current position of the mouse, in screen-coordinates.

Returns:: A Vector representing position.
Return type:: Vector

static get_mouse_abs_pos()[source]#: The current absolute position of the mouse. ie. screen coordinates. :rtype: Vector :returns: A Vector representing position.

classmethod mouse_is_visible()[source]#

Checks if the mouse is currently visible.

Returns:: True for visible, false otherwise.
Return type:: bool

classmethod set_mouse_visibility(toggle)[source]#

Sets the mouse visibility.

Parameters:: toggle (bool) – True to show the mouse and false to hide the mouse.

static pt_in_poly(pt, verts)[source]#

Checks if a point is inside a polygon.

Parameters:

pt (Vector) – The point to check.
verts (List[Vector]) – The polygon representation as a list of Vectors (vertices)

Returns:

Whether the point is inside the polygon.

Return type:

bool

classmethod mouse_in(center, dims=Vector(1, 1), angle=0)[source]#

Checks if the mouse is inside a rectangle defined by its center and dimensions

Parameters:

center (Vector) – The center of the rectangle.
dims (Vector) – The dimensions of the rectangle. Defaults to Vector(1, 1).
angle (float) – The angle of the rectangle in degrees. Defaults to 0.

Returns:

Whether or not the mouse is in the defined rectangle.

Return type:

bool

Sound#

A fully functional, multi-channel sound system.

class Sound(rel_path, sound_name=None)[source]#

Bases: object

A sound class that is used to manage the sounds throughout the project. We support the following audio formats:

MP3
WAV
OGG
FLAC
MOD
MIDI (not always available on linux)
OPUS
AIFF
VOC

Parameters:

rel_path (str) – The relative path to the sound file you wish to import.
sound_name (Optional[str]) – The name of the sound. Defaults to the name of the file.

loaded_sounds#

A dictionary housing all the loaded sounds, stored by their name.

Type:: Dict[str, Sound]

active_channels#

A dictionary housing all the active sounds, stored by their name.

Type:: Dict[int, Sound]

property state: int#

The current state of the sound.

The possible states are:

Sound.STOPPED
Sound.PLAYING
Sound.PAUSED

Returns:: The current state of the sound.
Return type:: int

play(loops=0, init_volume=None)[source]#

Plays a sound.

Parameters:

loops (int) – The number of times to loop a sound after the first play through. Use -1 to loop forever. Defaults to 0.’
init_volume (Optional[int]) – The initail volume of the sound. Defaults to the volume of the sound. range(0, MIX_MAX_VOLUME=>128)

stop()[source]#: Stops all instances of the sound.

pause()[source]#: Pauses all instances of the sound.

resume()[source]#: Resumes all instance of the sound.

set_volume(volume)[source]#

Sets the volume of the sound.

Parameters:: volume (int) – The volume of the sound. range(0, MIX_MAX_VOLUME=>128)

get_volume()[source]#

Gets the volume of the sound.

Return type:: int
Returns:: The volume of the sound. range(0, MIX_MAX_VOLUME=>128)

classmethod import_sound_folder(rel_path, duplicate_names=False, recursive=True)[source]#

Imports a folder of sounds, saving each one in the loaded_sounds dictionary by filename.

Parameters:

rel_path (str) – The relative path to the folder you wish to import.
duplicate_names – if you wish to have duplicate names to your sounds,
name (it will use the relative and the sound path for the sounds) –
recursive (bool) – Whether it will import an animation shallowly or recursively. Defaults to True.

classmethod get_sound(sound_name)[source]#

Gets the sound based on the sound name.

Parameters:: sound_name (str) – The name of the sound.
Raises:: IdError – No sound is associated to the sound name.
Returns:: The sound.
Return type:: Sound

Utilities#

These classes are utility classes that are used to make certain tasks easier.

Sprite#

A sprite is a class that handles rendering of images.

class Sprite(rel_path, pos=Vector(), rotation=0, scale=Vector(1, 1), aa=True)[source]#

Bases: object

A sprite is a class that handles rendering of images independent of Game Objects.

Parameters:

rel_path (str) – The relative path to the image.
pos (Vector) – The position to draw the image at. Defaults to Vector(0, 0).
rotation (float) – The rotation of the image. Defaults to 0.
scale (Vector) – The scale of the image. Defaults to Vector(1, 1).
aa (bool) – Whether anti aliasing is turned on. Defaults to True.

image#: The image that is rendered. This is an SDL_Surface or a string in the surface hasn’t been set yet.

pos#: The position of the image.

property rotation: float#

The rotation of the sprite.

Return type:: float

property scale: Vector#

The scale of the sprite.

Return type:: Vector

property aa: bool#

Whether anti-aliasing is enabled.

Return type:: bool

get_size()[source]#

Gets the current size of the image.

Return type:: Vector
Returns:: The size of the image

get_size_original()[source]#

Gets the original size of the image.

Returns:: The original size of the image.
Return type:: Vector

update()[source]#: Updates the rotozoom of the sprite if any changes were made.

delete()[source]#: Deletes the sprite

clone()[source]#: Creates a clone of the sprite.

Draw#

A static draw class for drawing things directly to the renderer.

class DrawTask(priority, func)[source]#: Bases: object

class Draw[source]#

Bases: object

Draws things to the renderer. Don’t instantiate, instead use it as a static class.

classmethod clear(background_color=Color.white, border_color=Color.black)[source]#

Clears the renderer and draws the background of the frame.

Parameters:

background_color (Color) – The background color. Defaults to white.
border_color (Color) – The border color. Defaults to black. Shown when the aspect ratio of the game does not match the aspect ratio of the window.

classmethod push(z_index, callback)[source]#

Add a custom draw function to the frame queue.

Parameters:

z_index (int) – The z_index to call at (lower z_indexes get called first).
callback (Callable) – The function to call.

classmethod dump()[source]#: Draws all queued items. Is called automatically at the end of every frame.

classmethod queue_point(pos, color=Color.green, z_index=Math.INF)[source]#

Draw a point onto the renderer at the end of the frame.

Parameters:

pos (Vector) – The position of the point.
color (Color) – The color to use for the pixel. Defaults to Color.green.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static point(pos, color=Color.green)[source]#

Draw a point onto the renderer immediately.

Parameters:

pos (Vector) – The position of the point.
color (Color) – The color to use for the pixel. Defaults to Color.green.

classmethod queue_line(p1, p2, color=Color.green, width=1, z_index=Math.INF)[source]#

Draw a line onto the renderer at the end of the frame.

Parameters:

p1 (Vector) – The first point of the line.
p2 (Vector) – The second point of the line.
color (Color) – The color to use for the line. Defaults to Color.green.
width (int) – The width of the line. Defaults to 1.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static line(p1, p2, color=Color.green, width=1)[source]#

Draw a line onto the renderer immediately.

Parameters:

p1 (Vector) – The first point of the line.
p2 (Vector) – The second point of the line.
color (Color) – The color to use for the line. Defaults to Color.green.
width (int) – The width of the line. Defaults to 1.

classmethod queue_rect(center, width, height, border=Color.clear, border_thickness=1, fill=None, angle=0, z_index=Math.INF)[source]#

Draws a rectangle onto the renderer at the end of the frame.

Parameters:

center (Vector) – The center of the rectangle.
width (int) – The width of the rectangle.
height (int) – The height of the rectangle.
border (Color) – The border color. Defaults to Color.clear.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.
angle (float) – The angle in degrees. Defaults to 0.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static rect(center, width, height, border=Color.clear, border_thickness=1, fill=None, angle=0)[source]#

Draws a rectangle onto the renderer immediately.

Parameters:

center (Vector) – The center of the rectangle.
width (int) – The width of the rectangle.
height (int) – The height of the rectangle.
border (Color) – The border color. Defaults to Color.clear.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.
angle (float) – The angle in degrees. Defaults to 0.

classmethod queue_circle(center, radius=4, border=Color.clear, border_thickness=1, fill=None, z_index=Math.INF)[source]#

Draws a circle onto the renderer at the end of the frame.

Parameters:

center (Vector) – The center.
radius (int) – The radius. Defaults to 4.
border (Color) – The border color. Defaults to green.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static circle(center, radius=4, border=Color.clear, border_thickness=1, fill=None)[source]#

Draws a circle onto the renderer immediately.

Parameters:

center (Vector) – The center.
radius (int) – The radius. Defaults to 4.
border (Color) – The border color. Defaults to green.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.

classmethod queue_poly(points, border=Color.clear, border_thickness=1, fill=None, z_index=Math.INF)[source]#

Draws a polygon onto the renderer at the end of the frame.

Parameters:

points (List[Vector]) – The list of points to draw.
border (Color) – The border color. Defaults to green.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static poly(points, border=Color.clear, border_thickness=1, fill=None)[source]#

Draws a polygon onto the renderer immediately.

Parameters:

points (List[Vector]) – The list of points to draw.
border (Color) – The border color. Defaults to green.
border_thickness (int) – The border thickness. Defaults to 1.
fill (Optional[Color]) – The fill color. Defaults to None.

classmethod queue_text(text, font, pos=Vector(), justify='left', align=Vector(), width=0, z_index=Math.INF)[source]#

Draws some text onto the renderer at the end of the frame.

Parameters:

text (str) – The text to draw.
font (Font) – The Font object to use.
pos (Vector) – The position of the text. Defaults to Vector(0, 0).
justify (str) – The justification of the text. (left, center, right). Defaults to “left”.
align (Vector) – The alignment of the text. Defaults to Vector(0, 0).
width (int) – The maximum width of the text. Will automatically wrap the text. Defaults to -1.
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static text(text, font, pos=Vector(), justify='left', align=Vector(), width=0)[source]#

Draws some text onto the renderer immediately.

Parameters:

text (str) – The text to draw.
font (Font) – The Font object to use.
pos (Vector) – The position of the text. Defaults to Vector(0, 0).
justify (str) – The justification of the text. (left, center, right). Defaults to “left”.
align (Vector) – The alignment of the text. Defaults to Vector(0, 0).
width (int) – The maximum width of the text. Will automatically wrap the text. Defaults to -1.

classmethod queue_texture(texture, pos=Vector(), z_index=Math.INF)[source]#

Draws an texture onto the renderer at the end of the frame.

Parameters:

texture (Texture) – The texture to draw.
pos (Vector) – The position of the texture. Defaults to Vector(0, 0).
z_index (int) – Where to draw it in the drawing order. Defaults to Math.INF.

static texture(texture, pos=Vector())[source]#

Draws an SDL Texture onto the renderer immediately.

Parameters:

texture (Texture) – The texture to draw.
pos (Vector) – The position to draw the texture at. Defaults to Vector().

classmethod queue_sprite(sprite, pos=Vector(), z_index=0)[source]#

Draws an sprite onto the renderer at the end of the frame.

Parameters:

sprite (Sprite) – The sprite to draw.
pos (Vector) – The position to draw the sprite at. Defaults to Vector(0, 0).
z_index (int) – The z-index of the sprite. Defaults to 0.

static sprite(sprite, pos=Vector())[source]#

Draws an sprite onto the renderer immediately.

Parameters:

sprite (Sprite) – The sprite to draw.
pos (Vector) – The position to draw the sprite at. Defaults to Vector().

Vector#

A vector implementation.

class Vector(x=0, y=0)[source]#

Bases: object

A Vector object that defines a 2D point in space

Parameters:

x (UnionType[float, int]) – The x coordinate. Defaults to 0.
y (UnionType[float, int]) – The y coordinate. Defaults to 0.

x#

The x coordinate.

Type:: float | int

y#

The y coordinate.

Type:: float | int

property magnitude: float#

The magnitude of the vector. You can set to this value.

Return type:: float

property mag_sq: float#

The squared magnitude of the vector (readonly).

Return type:: float

property angle: float#

The angle of the vector degrees (readonly).

Return type:: float

property rationalized_mag: str#

Returns a string representation of a rationalized vector magnitude as you would use in math class.

Example

>>> Vector(8, 8).rationalized_mag
4√8

Warning

Should only be used on vectors with integer components.

Return type:: str

property rationalized_mag_vector: Vector#

Returns a vector with the rationalized magnitude.

Example

>>> Vector(8, 8).rationalized_mag
rubato.Vector(4, 8)

Warning

Should only be used on vectors with integer components.

Return type:: Vector

property rationalized_unit: str#

Returns a string representation of a rationalized unit vector as you would use in math class.

Warning

Should only be used on vectors with integer components.

Return type:: str

normalized(out=None)[source]#

Determines the unit vector of this vector.

Parameters:: out (Vector, optional) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.
Returns:: The vector output of the operation.
Return type:: Vector

normalize()[source]#: Normalizes the current vector.

sum()[source]#: Sums the x and y coordinates of the vector.

to_tuple()[source]#

Returns the x and y coordinates of the vector as a tuple.

Return type:: tuple

dot(other)[source]#

Takes the dot product of two vectors.

Parameters:: other (Vector) – The other vector.
Return type:: UnionType[float, int]
Returns:: The resulting dot product.

cross(other)[source]#

Takes the cross product of two vectors.

Parameters:: other (Vector) – The other vector.
Return type:: UnionType[float, int]
Returns:: The resultant scalar magnitude of the orthogonal vector along an imaginary z-axis.

perpendicular(scalar=1, out=None)[source]#

Computes a scaled 90 degree clockwise rotation on a given vector.

Parameters:

scalar (UnionType[float, int]) – The scalar value.
out (Optional[Vector]) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.

Return type:

Vector

Returns:

The resultant vector when transformed.

clamp(lower, upper, absolute=False, out=None)[source]#

Clamps x and y between the two values given.

Parameters:

lower (UnionType[Vector, float, int]) – The lower bound. If a vector is specified, its x coord is used to clamp the x coordinate and same for y.
upper (UnionType[Vector, float, int]) – The upper bound. If a vector is specified, its x coord is used to clamp the x coordinate and same for y.
absolute (bool) – Whether to clamp the absolute value of the vector instead of the actual value. Defaults to False.
out (Optional[Vector]) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.

rotate(angle, out=None)[source]#

Rotates the vector by a given number of degrees.

Parameters:

angle (UnionType[float, int]) – The rotation amount in north-degrees you want to rotate by (relative).
out (Optional[Vector]) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.

Return type:

Vector

Returns:

The resultant Vector.

to_int()[source]#

Returns a new vector with values that are ints.

Return type:: Vector

tuple_int()[source]#

Returns a tuple with rounded values.

Return type:: tuple

clone()[source]#

Returns a copy of the vector.

Return type:: Vector

lerp(target, t, out=None)[source]#

Lerps the current vector to target by a factor of t.

Parameters:

target (Vector) – The target Vector.
t (float) – The lerping amount (between 0 and 1).
out (Optional[Vector]) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.

Return type:

Vector

Returns:

The resulting vector.

round(decimal_places=0, out=None)[source]#

Returns a new vector with the coordinates rounded.

Parameters:

decimal_places (int) – The amount of decimal places rounded to. Defaults to 0.
out (Vector, optional) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.

Returns:

The resultant Vector.

Return type:

Vector

ceil(out=None)[source]#

Returns a new vector with the coordinates ciel-ed.

Parameters:: out (Vector, optional) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.
Returns:: The resultant Vector.
Return type:: Vector

floor(out=None)[source]#

Returns a new vector with the coordinates floored.

Parameters:: out (Vector, optional) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.
Returns:: The resultant Vector.
Return type:: Vector

abs(out=None)[source]#

Returns a new vector with the absolute value of the original coordinates.

Parameters:: out (Vector, optional) – The output vector to set to. Defaults to a new vector. If you want the function to act on itself, set this value to the reference of the vector.
Returns:: The resultant Vector.
Return type:: Vector

dir_to(other)[source]#

Direction from the Vector to another Vector.

Parameters:: other (Vector) – the position to which you are pointing
Return type:: Vector
Returns:: A unit vector that is in the pointing to the other position passed in

distance_between(other)[source]#

Finds the pythagorean distance between two vectors.

Parameters:: other (Vector) – The other vector.
Returns:: The distance.
Return type:: float

static from_radial(magnitude, angle)[source]#

Generates a Vector from the given angle and magnitude.

Parameters:

magnitude (float) – Length of vector.
angle (float) – Direction of vector in North degrees.

Return type:

Vector

Returns:

Vector from the given direction and distance

static clamp_magnitude(vector, max_magnitude, min_magnitude=0)[source]#

Clamps the magnitude of the vector to the given range.

Parameters:

vector (Vector) – The vector to clamp.
max_magnitude (float) – The maximum magnitude of the vector.
min_magnitude (float) – The minimum magnitude of the vector. Defaults to 0.

Return type:

Vector

Returns:

A new vector with the magnitude clamped to the given range.

classmethod angle_between(a, b)[source]#

Returns the smallest possible angle between two vectors.

Parameters:

a (Vector) – First vector.
b (Vector) – Second vector.

Return type:

float

Returns:

Angle in degrees between the two vectors.

classmethod rand_unit_vector()[source]#

Returns a random unit vector inside the unit circle.

Return type:: Vector
Returns:: Random vector inside the unit circle.

class property zero[source]#: A zeroed Vector

class property one: Vector[source]#

A Vector with all ones

Return type:: Vector

class property up[source]#: A Vector in the up direction

class property left[source]#: A Vector in the left direction

class property down[source]#: A Vector in the down direction

class property right[source]#: A Vector in the right direction

class property infinity[source]#: A Vector at positive infinity

Math#

The math module includes some helper functions for commonly used equations.

class Math[source]#

Bases: object

A more complete math class.

INF#

The max value of a float.

Type:: float

PI_HALF#

The value of pi / 2.

Type:: float

PI_TWO#

The value of pi * 2.

Type:: float

static clamp(a, lower, upper)[source]#

Clamps a value.

Parameters:

a (UnionType[float, int]) – The value to clamp.
lower (UnionType[float, int]) – The lower bound of the clamp.
upper (UnionType[float, int]) – The upper bound of the clamp.

Returns:

The clamped result.

Return type:

float

static sign(n)[source]#

Checks the sign of n.

Parameters:: n (UnionType[float, int]) – A number to check.
Return type:: int
Returns:: The sign of the number. (1 for positive, 0 for 0, -1 for negative)

static lerp(a, b, t)[source]#

Linearly interpolates between lower and upper bounds by t

Parameters:

a (UnionType[float, int]) – The lower bound.
b (UnionType[float, int]) – The upper bound.
t (float) – Distance between upper and lower (1 gives b, 0 gives a).

Returns:

The linearly interpolated value.

Return type:

float

classmethod map(variable, variable_lower, variable_upper, map_lower, map_upper)[source]#

Maps the variable from its range defined by lower and upper to a new range defined by map_lower and map_upper.

Parameters:

variable – The variable to map.
variable_lower – The lower bound of the variable.
variable_upper – The upper bound of the variable.
map_lower – The lower bound of the new range.
map_upper – The upper bound of the new range.

Returns:

The mapped value.

Return type:

float

static floor(x)[source]#

Quickly rounds down a number.

Parameters:: x (float) – The number to round.
Returns:: The rounded number.
Return type:: int

static ceil(x)[source]#

Quickly rounds up a number.

Parameters:: x (float) – The number to round.
Returns:: The rounded number.
Return type:: int

static is_int(x, error=0)[source]#

Checks if a float can be rounded to an integer without dropping decimal places (within a certain error).

Parameters:

x (float) – The number to check.
error (float) – The error margin from int that we accept, used for float inaccuracy.

Return type:

bool

Returns:

True if the number is an integer within the error.

static simplify_sqrt(square_rooted)[source]#

Simplifies a square root.

Parameters:: square_rooted (int) – The sqrt to simplify (inside the sqrt).
Return type:: tuple
Returns:: The simplified square root, (multiple, square rooted).

Example

Will try to simplify radicals.

>>> Math.simplify_sqrt(16) # √16 = 4√1
(4, 1)
>>> Math.simplify_sqrt(26) # √26 = 1√26
(1, 26)
>>> Math.simplify_sqrt(20) # √20 = 2√5

static simplify(a, b)[source]#

Simplifies a fraction.

Parameters:

a (int) – numerator.
b (int) – denominator.

Return type:

tuple

Returns:

The simplified fraction, (numerator, denominator).

static gen_primes()[source]#

Generate an infinite sequence of prime numbers. A python generator ie. must use next().

Notes

Sieve of Eratosthenes Code by David Eppstein, UC Irvine, 28 Feb 2002 http://code.activestate.com/recipes/117119/

Returns:: A generator of prime numbers.
Return type:: generator

Example

>>> generator = Math.gen_primes()
>>> next(generator)
2

static north_deg_to_rad(deg)[source]#

Converts a north-degrees (naturally used in rubato) to east-radians.

Parameters:: deg (float) – North-degrees.
Return type:: float
Returns:: East-radians.

static rad_to_north_deg(rad)[source]#

Converts east-radians to north-degrees (naturally used in rubato).

Parameters:: rad (float) – East-radians.
Return type:: float
Returns:: North-degrees.

Noise#

A utility for generating simple smooth noise in your projects.

class Noise[source]#

Bases: object

A modified implementation of the OpenSimplex2 algorithm.

seed#

The seed for the random noise. Setting to a fixed value will result in the same noise every time.

Type:: int

classmethod noise(x)[source]#

Creates noise from 1 dimensional input. This is identical to noise2(x, 0).

Parameters:: x (float) – the x coordinate of noise.
Returns:: the random noise value.
Return type:: float

classmethod noise2(x, y)[source]#

Creates noise from 2 dimensional input.

Parameters:

x (float) – the x coordinate of noise.
y (float) – the y coordinate of noise.

Returns:

the random noise value.

Return type:

float

Time#

A static time class to monitor time and to call functions in the future.

class DelayedTask(delay, task, is_stopped=False)[source]#

Bases: object

A task that is run after a specified number of milliseconds.

stop()[source]#: Stop the DelayedTask from invoking.

class FramesTask(delay, task, is_stopped=False)[source]#

Bases: object

A task that is run after a specified number of frames.

stop()[source]#: Stop the FramesTask from invoking.

class ScheduledTask(interval, task, delay=0, is_stopped=False)[source]#

Bases: object

A task that is run every specified number of milliseconds.

stop()[source]#: Stop the ScheduledTask from invoking.

class Time[source]#

Bases: object

The time class

frames#

The total number of elapsed frames since the start of the game.

Type:: int

fps#

The current fps of this frame.

Type:: float

target_fps#

The fps that the game should try to run at. 0 means that the game’s fps will not be capped. Defaults to 0.

Type:: float

physics_fps#

The fps that the physics should run at. Defaults to 60.

Type:: float

delta_time#

The number of seconds since the last frame.

Type:: int

fixed_delta#

The number of seconds since the last fixed update.

Type:: int

class property smooth_fps: float#

The average fps over the past 120 frames. This is a get-only property.

Return type:: float

classmethod now()[source]#

The time since the start of the game, in milliseconds.

Return type:: int

class property frame_start: int#

The time since the start of the game, in milliseconds, taken at the start of the frame. This is a get-only property.

Return type:: int

classmethod schedule(task)[source]#

Schedules a task for delayed execution based on what type of task it is.

Parameters:: task (DelayedTask | FramesTask | ScheduledTask) – The task to queue.

classmethod delayed_call(delay, func)[source]#

Calls the function func at a later time.

Parameters:

delay (int) – The time from now (in milliseconds) to run the function at.
func (Callable) – The function to call.

classmethod delayed_frames(delay, func)[source]#

Calls the function func at a later frame.

Parameters:

delay (int) – The number of frames to wait.
func (Callable) – The function to call

classmethod scheduled_call(interval, func)[source]#

Calls the function func at a scheduled interval.

Parameters:

interval (int) – The interval (in milliseconds) to run the function at.
func (Callable) – The function to call.

classmethod milli_to_sec(milli)[source]#

Converts milliseconds to seconds.

Parameters:: milli (int) – A number in milliseconds.
Returns:: The converted number in seconds.
Return type:: float

classmethod sec_to_milli(sec)[source]#

Converts seconds to milliseconds.

Parameters:: sec (int) – A number in seconds.
Returns:: The converted number in milliseconds.
Return type:: float

classmethod process_calls()[source]#: Processes the delayed function call as needed

Color#

This color module contains the Color class, which is used to represent colors in the game.

class Color(r=0, g=0, b=0, a=255)[source]#

Bases: object

An RGBA color.

Parameters:

r (UnionType[int, float]) – The red value. Defaults to 0.
g (UnionType[int, float]) – The green value. Defaults to 0.
b (UnionType[int, float]) – The blue value. Defaults to 0.
a (UnionType[int, float]) – The alpha value. Defaults to 255.

r#

The red value.

Type:: int

g#

The green value.

Type:: int

b#

The blue value.

Type:: int

a#

The alpha value.

Type:: int

property rgba32#: The RGBA32 representation of the color.

darker(amount=20)[source]#

Returns a darker copy of the color. It subtracts amount from the RGB values.

Parameters:: amount (int) – How much darker. Defaults to 20.
Returns:: The resultant color.
Return type:: Color

lighter(amount=20)[source]#

Returns a lighter copy of the color. It adds amount to the RGB values.

Parameters:: amount (int) – How much lighter. Defaults to 20.
Returns:: The resultant color.
Return type:: Color

mix(other, t=0.5, mode='mix')[source]#

Mix two colors together.

Parameters:

other (Color) – The other color.
t (float) – The interpolation amount (0 to 1). Defaults to 0.5.
mode (str) – The blending mode (“linear”, “mix”, “blend”). Linear is the linear interpolation between the two colors. Mix and Blend are 2 different algorithms to mix colors. They tend to look better then linear. Defaults to “mix”.

Returns:

The resultant color.

Return type:

Color

to_tuple()[source]#

Converts the Color to a tuple.

Returns:: The tuple representing the color.
Return type:: tuple(int, int, int, int)

to_hex()[source]#

Converts the Color to a hexadecimal string.

Returns:: The hexadecimal output in lowercase. (i.e. ffffffff)
Return type:: str

to_hsv()[source]#

Converts the Color to a tuple containing its HSV values.

Returns:: The Color values as HSV in the form of a tuple.
Return type:: tuple[int]

static random_default(grayscale=False)[source]#

Returns a random default Color.

Parameters:: grayscale (bool, optional) – Whether to add grayscale colors. Defaults to False.
Returns:: A random default Color.
Return type:: Color

classmethod from_rgba32(rgba32)[source]#

Creates a Color object from an RGBA32 representation.

Parameters:: rgba32 (int) – The RGBA32 representation as an int.
Returns:: The color object from the RGBA32.
Return type:: Color

classmethod from_hex(h)[source]#

Creates a Color object from a hex string.

Parameters:: h (str) – The hexadecimal value in the format “RRGGBBAA”.
Returns:: The Color object.
Return type:: Color

classmethod from_hsv(h, s, v, a=1)[source]#

Creates a Color object from HSV values.

Parameters:

h (float) – The hue degree (0 to 360).
s (float) – The saturation proportion (0 to 1).
v (float) – The value proportion (0 to 1).
a (float) – The alpha proportion (0 to 1).

Returns:

The Color object.

Return type:

Color

classmethod random()[source]#

A random color.

Return type:: Color

class property clear: Color[source]#

A transparent color object.

Return type:: Color

class property black: Color[source]#

The default black color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property white: Color[source]#

The default white color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property night: Color[source]#

The default night color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property darkgray: Color[source]#

The default darkgray color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property gray: Color[source]#

The default gray color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property lightgray: Color[source]#

The default lightgray color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property snow: Color[source]#

The default snow color. To see the RGB values, check out the Grayscale defaults.

Return type:: Color

class property yellow: Color[source]#

The default yellow color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property orange: Color[source]#

The default orange color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property red: Color[source]#

The default red color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property scarlet: Color[source]#

The default scarlet color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property magenta: Color[source]#

The default magenta color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property purple: Color[source]#

The default purple color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property violet: Color[source]#

The default violet color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property blue: Color[source]#

The default blue color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property cyan: Color[source]#

The default cyan color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property turquoize: Color[source]#

The default turquoize color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property green: Color[source]#

The default green color. To see the RGB values, check out the Color defaults.

Return type:: Color

class property lime: Color[source]#

The default lime color. To see the RGB values, check out the Color defaults.

Return type:: Color

Default Colors#

_color_defaults = {
    "yellow": (253, 203, 110),  # . . . . . . . . . . . . . . . tuple
    "scarlet": (214, 48, 49),  #. . . . . . . . . . . . . . . . tuple
    "violet": (108, 92, 231),  #. . . . . . . . . . . . . . . . tuple
    "turquoize": (0, 206, 201),  #. . . . . . . . . . . . . . . tuple
    "orange": (225, 112, 85),  #. . . . . . . . . . . . . . . . tuple
    "magenta": (232, 67, 147),  # . . . . . . . . . . . . . . . tuple
    "blue": (9, 132, 227),  # . . . . . . . . . . . . . . . . . tuple
    "green": (0, 184, 148),  #. . . . . . . . . . . . . . . . . tuple
    "red": (255, 118, 117),  #. . . . . . . . . . . . . . . . . tuple
    "purple": (162, 155, 254),  # . . . . . . . . . . . . . . . tuple
    "cyan": (116, 185, 255),  # . . . . . . . . . . . . . . . . tuple
    "lime": (85, 239, 196),  #. . . . . . . . . . . . . . . . . tuple

    # colorwheel used (rgb values are not identical):
    # https://upload.wikimedia.org/wikipedia/commons/5/54/RGV_color_wheel_1908.png
}

Default Grayscale Colors#

_grayscale_defaults = {
    "black": (0, 0, 0),  #. . . . . . . . . . . . . . . . . . . tuple
    "white": (255, 255, 255),  #. . . . . . . . . . . . . . . . tuple
    "night": (20, 20, 22),  # . . . . . . . . . . . . . . . . . tuple
    "darkgray": (45, 52, 54),  #. . . . . . . . . . . . . . . . tuple
    "gray": (99, 110, 114),  #. . . . . . . . . . . . . . . . . tuple
    "lightgray": (178, 190, 195),  #. . . . . . . . . . . . . . tuple
    "snow": (223, 230, 233),  # . . . . . . . . . . . . . . . . tuple
}

Debug#

This Debug module provides a set of functions to help with debugging.

class Debug[source]#

Bases: object

Debug comes with useful functions to help with debugging.

static draw_fps(font)[source]#

static find_my_print()[source]#: Will print the stack when it finds a print statement. .. admonition:: Examples

Place this next to your rubato import. >>> Debug.find_my_print()

static error_my_print()[source]#: Will break the program if it finds a print statement.

Examples

Place this next to your rubato import. >>> Debug.error_my_print()

Font#

The font module for text rendering

class Font(font='Roboto', size=16, styles=[], color=Color(0, 0, 0))[source]#

Bases: object

This is the font object that is used to render text.

Parameters:

font (Union[str, Literal[‘Comfortaa’, ‘Fredoka’, ‘Merriweather’, ‘Roboto’, ‘SourceCodePro’, ‘PressStart’]]) – The font to use. Can also be a path to a font file. Defaults to Roboto.
size (int) – The size of the font. Defaults to 16.
styles (List[str]) – The styles to apply to the font. Defaults to []. Fill with only the following: bold, italic, underline, strikethrough.
color (Color) – The color of the font. Defaults to Color(0, 0, 0).

property size: int#

The size of the text in points.

Return type:: int

property color: Color#

The color of the text.

Return type:: Color

generate_surface(text, align=Vector(0, 0), width=0, rot=0)[source]#

Generate the surface containing the text.

Parameters:

text (str) – The text to render.
align (Vector) – The alignment to use. Defaults to Vector(0, 0).
width (int) – The maximum width to use. Defaults to -1.
rot (int) – The rotation of the text in degrees. Defaults to 0.

Raises:

ValueError – The width is too small for the text.
ValueError – The size of the text is too large for the font.

Returns:

The surface containing the text.

Return type:

sdl2.SDL_Surface

add_style(style)[source]#

Adds a style to the font.

Parameters:: style (str) – The style to add. Can be one of the following: bold, italic, underline, strikethrough.

remove_style(style)[source]#

Removes a style from the font.

Parameters:: style (str) – The style to remove. Can be one of the following: bold, italic, underline, strikethrough.

apply_styles()[source]#: Applies the styles to the font.

Radio#

The Radio module is a system used to communicate to all parts of the game. This is similar to event systems in other game engines.

To use this, first you need to listen for a specific key using the Radio.listen() function. Then from anywhere else in the code, you can broadcast that event key using Radio.broadcast().

Go here to see all the events that can be broadcast.

class Events[source]#

Bases: object

Describes all rubato-fired events that can be listened for.

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)

MOUSEUP#: Fired when a mouse button is released

MOUSEDOWN#: Fired when a mouse button is pressed

ZOOM#: Fired when the camera is zoomed

EXIT#: Fired when the game is exiting

RESIZE#: Fired when the window is resized

class Radio[source]#

Bases: object

Broadcast system manages all events and inter-class communication. Handles event callbacks during the beginning of each Game.update() call.

listeners#

A dictionary with all of the active listeners.

Type:: dict[str, Callable]

classmethod handle()[source]#: Handle the event queue

classmethod listen(event, func)[source]#

Creates an event listener and registers it.

Parameters:

event (str) – The event key to listen for.
func (Callable) – The function to run once the event is broadcast. It may take in a params dictionary argument.

classmethod register(listener)[source]#

Registers an event listener.

Parameters:: listener (Listener) – The listener object to be registered

classmethod broadcast(event, params={})[source]#

Broadcast an event to be caught by listeners.

Parameters:

event (str) – The event key to broadcast.
params – The event parameters (usually a dictionary)

class Listener(event, callback)[source]#

Bases: object

The actual listener object itself. A backend class for the Radio.

Parameters:

event (str) – The event key to listen for.
callback (Callable) – The function to run once the event is broadcast.

event#

The event descriptor

Type:: str

callback#

The function called when the event occurs

Type:: Callable

registered#

Describes whether the listener is registered

Type:: bool

ping(params)[source]#

Calls the callback of this listener.

Parameters:: params – The event parameters (usually a dictionary)

remove()[source]#

Removes itself from the radio register.

Raises:: ValueError – Raises error when listener is not registered

Errors#

Some custom errors

exception Error[source]#

Bases: Exception

A basic rubato Error.

exception IdError[source]#

Bases: Exception

An error that is raised when an invalid ID is used.

exception SideError[source]#

Bases: Exception

An error that is raised when the number of sides is invalid

exception DuplicateComponentError[source]#

Bases: Exception

An error that is raised when you try to add a component to a game object that already has a component of the same type

exception ComponentNotAllowed[source]#

Bases: Exception

An error that is raised when you try to add a component on a game object that is not allowed by another component on that game object.

exception ImplementationError[source]#

Bases: Exception

An error that is raised when you incorrectly implement something in rubato.

exception PrintError[source]#

Bases: Exception

An error that is raised when you try to print something, and are checking for it with Debug.

exception RemovalWarning[source]#

Bases: DeprecationWarning

A warning that is raised when you try to use a removed function.

deprecated(other_func)[source]#: This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.

deprecated_no_replacement(func)[source]#: This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.

removed(other_func=None)[source]#: This is a decorator which can be used to mark functions as removed, they will no longer work.

Miscellaneous#

Miscellaneous helper functions for rubato developers.

world_mouse()[source]#

Returns the mouse position in world-coordinates.

Returns:: The mouse position in world coordinates.
Return type:: Vector

wrap(comp, name='', pos=Vector(), rotation=0, z_index=0, debug=False)[source]#

Wraps a component or list of components in a GameObject.

Parameters:

comp (Union[Component, List[Component]]) – The component or list of components to wrap.
name (str) – The name of the GameObject. Defaults to “”.
pos (Vector) – The position of the GameObject. Defaults to Vector().
rotation (float) – The rotation of the GameObject. Defaults to 0.
z_index (int) – The z_index of the GameObject. Defaults to 0.
debug (bool) – Whether the GameObject is in debug mode. Defaults to False.

Raises:

TypeError – If comp is not a Component or a list of Components.

Returns:

The wrapped GameObject.