pygame._sdl2.controller
Pygame module to work with controllers.
—initialize the controller module
—Uninitialize the controller module.
—Returns True if the controller module is initialized.
—Sets the current state of events related to controllers
—Gets the current state of events related to controllers
—Get the number of joysticks connected
—Check if the given joystick is supported by the game controller interface
—Get the name of the controller
—Create a new Controller object.

This module offers control over common controller types like the dualshock 4 orthe xbox 360 controllers: They have two analog sticks, two triggers, two shoulder buttons,a dpad, 4 buttons on the side, 2 (or 3) buttons in the middle.

Pygame uses xbox controllers naming conventions (like a, b, x, y for buttons) butthey always refer to the same buttons. For exampleCONTROLLER_BUTTON_X isalways the leftmost button of the 4 buttons on the right.

Controllers can generate the following events:

CONTROLLERAXISMOTION,CONTROLLERBUTTONDOWN,CONTROLLERBUTTONUP,CONTROLLERDEVICEREMAPPED,CONTROLLERDEVICEADDED,CONTROLLERDEVICEREMOVED

Additionally if pygame is built with SDL 2.0.14 or higher the following events can also be generated(to get the version of sdl pygame is built with usepygame.version.SDL()tupled integers of the SDL library version):

CONTROLLERTOUCHPADDOWN,CONTROLLERTOUCHPADMOTION,CONTROLLERTOUCHPADUP

These events can be enabled/disabled bypygame._sdl2.controller.set_eventstate()Sets the current state of events related to controllersNote that controllers can generate joystick events as well. This function only togglesevents related to controllers.

New in pygame 2:This module requires SDL2.

pygame._sdl2.controller.init()
initialize the controller module
init() -> None

Initialize the controller module.

pygame._sdl2.controller.quit()
Uninitialize the controller module.
quit() -> None

Uninitialize the controller module.

pygame._sdl2.controller.get_init()
Returns True if the controller module is initialized.
get_init() -> bool

Test ifpygame._sdl2.controller.init() was called.

pygame._sdl2.controller.set_eventstate()
Sets the current state of events related to controllers
set_eventstate(state) -> None

Enable or disable events connected to controllers.

Note

Controllers can still generate joystick events, which will not be toggled by this function.

Changed in pygame 2.0.2::Changed return type from int to None

pygame._sdl2.controller.get_eventstate()
Gets the current state of events related to controllers
get_eventstate() -> bool

Returns the current state of events related to controllers, True meaningevents will be posted.

New in pygame 2.0.2.

pygame._sdl2.controller.get_count()
Get the number of joysticks connected
get_count() -> int

Get the number of joysticks connected.

pygame._sdl2.controller.is_controller()
Check if the given joystick is supported by the game controller interface
is_controller(index) -> bool

Returns True if the index given can be used to create a controller object.

pygame._sdl2.controller.name_forindex()
Get the name of the controller
name_forindex(index) -> name or None

Returns the name of controller, or None if there's no name or theindex is invalid.

pygame._sdl2.controller.Controller
Create a new Controller object.
Controller(index) -> Controller

Create a new Controller object. Index should be integer between0 andpygame._sdl2.controller.get_count(). Controllers alsocan be created from apygame.joystick.Joystick usingpygame._sdl2.controller.from_joystick. Controllers areinitialized on creation.

—uninitialize the Controller
—check if the Controller is initialized
—Create a Controller from a pygame.joystick.Joystick object
—Check if the Controller has been opened and is currently connected.
—Returns a pygame.joystick.Joystick() object
—Get the current state of a joystick axis
—Get the current state of a button
—Get the mapping assigned to the controller
—Assign a mapping to the controller
—Start a rumbling effect
—Stop any rumble effect playing
quit()
uninitialize the Controller
quit() -> None

Close a Controller object. After this the pygame event queue will no longerreceive events from the device.

It is safe to call this more than once.

get_init()
check if the Controller is initialized
get_init() -> bool

Returns True if the Controller object is currently initialised.

staticfrom_joystick()
Create a Controller from a pygame.joystick.Joystick object
from_joystick(joystick) -> Controller

Create a Controller object from apygame.joystick.Joystick object

attached()
Check if the Controller has been opened and is currently connected.
attached() -> bool

Returns True if the Controller object is opened and connected.

as_joystick()
Returns a pygame.joystick.Joystick() object
as_joystick() -> Joystick object

Returns a pygame.joystick.Joystick() object created from this controller's index

get_axis()
Get the current state of a joystick axis
get_axis(axis) -> int

Get the current state of a trigger or joystick axis.The axis argument must be one of the following constants:

CONTROLLER_AXIS_LEFTX,CONTROLLER_AXIS_LEFTY,CONTROLLER_AXIS_RIGHTX,CONTROLLER_AXIS_RIGHTY,CONTROLLER_AXIS_TRIGGERLEFT,CONTROLLER_AXIS_TRIGGERRIGHT

Joysticks can return a value between -32768 and 32767. Triggers howevercan only return a value between 0 and 32768.

get_button()
Get the current state of a button
get_button(button) -> bool

Get the current state of a button, True meaning it is pressed down.The button argument must be one of the following constants:

CONTROLLER_BUTTON_A,CONTROLLER_BUTTON_B,CONTROLLER_BUTTON_X,CONTROLLER_BUTTON_YCONTROLLER_BUTTON_DPAD_UP,CONTROLLER_BUTTON_DPAD_DOWN,CONTROLLER_BUTTON_DPAD_LEFT,CONTROLLER_BUTTON_DPAD_RIGHT,CONTROLLER_BUTTON_LEFTSHOULDER,CONTROLLER_BUTTON_RIGHTSHOULDER,CONTROLLER_BUTTON_LEFTSTICK,CONTROLLER_BUTTON_RIGHTSTICK,CONTROLLER_BUTTON_BACK,CONTROLLER_BUTTON_GUIDE,CONTROLLER_BUTTON_START
get_mapping()
Get the mapping assigned to the controller
get_mapping() -> mapping

Returns a dict containing the mapping of the Controller. For moreinformation seeController.set_mapping()

Changed in pygame 2.0.2::Return type changed fromstr todict

set_mapping()
Assign a mapping to the controller
set_mapping(mapping) -> int

Rebind buttons, axes, triggers and dpads. The mapping should be adict containing all buttons, hats and axes. The easiest way to get thisis to use the dict returned byController.get_mapping(). To editthis mapping assign a value to the original button. The value of thedictionary must be a button, hat or axis represented in the following way:

  • For a button use: bX where X is the index of the button.

  • For a hat use: hX.Y where X is the index and the Y is the direction (up: 1, right: 2, down: 3, left: 4).

  • For an axis use: aX where x is the index of the axis.

An example of mapping:

mapping=controller.get_mapping()# Get current mappingmapping["a"]="b3"# Remap button a to ymapping["y"]="b0"# Remap button y to acontroller.set_mapping(mapping)# Set the mapping

The function will return 1 if a new mapping is added or 0 if an existing one is updated.

Changed in pygame 2.0.2::Renamed fromadd_mapping toset_mapping

Changed in pygame 2.0.2::Argument type changed fromstr todict

rumble()
Start a rumbling effect
rumble(low_frequency, high_frequency, duration) -> bool

Start a rumble effect on the controller, with the specified strength rangingfrom 0 to 1. Duration is length of the effect, in ms. Setting the durationto 0 will play the effect until another one overwrites it orController.stop_rumble() is called. If an effect is alreadyplaying, then it will be overwritten.

Returns True if the rumble was played successfully or False if thecontroller does not support it orpygame.version.SDL()tupled integers of the SDL library version is below 2.0.9.

New in pygame 2.0.2.

stop_rumble()
Stop any rumble effect playing
stop_rumble() -> None

Stops any rumble effect playing on the controller. SeeController.rumble() for more information.

New in pygame 2.0.2.



Edit on GitHub