Skip to content

Input

Base class for all user inputs

name property readonly

control name

__init__(self, seat, name) special

Abstract init method

Parameters:

Name Type Description Default
seat int

controller seat

 required
name str

controller name

 required
Source code in game_sdk/controller/inputs/input.py 
def __init__(self, seat: int, name: str):
    """
        Abstract init method
        Arguments:
            seat: controller seat
            name: controller name
    """
    self._name = name

close(self, seat) async

Called when the program exits.

Parameters:

Name Type Description Default
seat int

controller seat

 required
Source code in game_sdk/controller/inputs/input.py 
async def close(self, seat: int):
    """
        Called when the program exits.

        Arguments:
            seat: controller seat
    """

init(self, seat) async

Executed at the beginning of the game. Initialize all controller inputs

Parameters:

Name Type Description Default
seat int

controller seat

 required
Source code in game_sdk/controller/inputs/input.py 
async def init(self, seat: int):
    """
        Executed at the beginning of the game. Initialize all controller inputs

        Arguments:
            seat: controller seat
    """

reset(self, seat) async

Executed at the end of the game. Resets all controller inputs

Parameters:

Name Type Description Default
seat int

controller seat

 required
Source code in game_sdk/controller/inputs/input.py 
async def reset(self, seat: int):
    """
        Executed at the end of the game. Resets all controller inputs

        Arguments:
            seat: controller seat
    """
Back to top