Controller#

Initializing the Controller Class#

To use a Controller in your project, start by initializing it as follows:

# Create a new object "controller" with the Controller class.
controller = Controller()

This controller object will be used in all subsequent examples throughout this API documentation when referring to Controller class methods and attributes.

The Controller class comes with three pre-defined attributes, though the screen attribute is only available if you are using a V5 Controller:

axis - Allows you to detect movements in the Controller’s joysticks and assign functions to axes events.
button - Allows you to detect button presses and assign functions to button events on the Controller.
screen - V5 Controller Only. Enables you to display text and draw images on the V5 Controller’s screen.

Attributes

Class Methods#

In addition to its attributes, the Controller has access to the rumble method if using a V5 Controller.

controller.rumble()#

The controller.rumble(pattern) method sends a rumble string to the V5 controller.

Parameter	Description
pattern	A pattern using ‘.’ and ‘-’ for short and long rumbles.

Returns: None

# Rumble the V5 Controller to the pattern short-short-long-long.
controller.rumble('..--')