# {py:mod}`simvx.core.input.players`

```{py:module} simvx.core.input.players
```

```{autodoc2-docstring} simvx.core.input.players
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`InputPlayer <simvx.core.input.players.InputPlayer>`
  - ```{autodoc2-docstring} simvx.core.input.players.InputPlayer
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.input.players.__all__>`
  - ```{autodoc2-docstring} simvx.core.input.players.__all__
    :summary:
    ```
* - {py:obj}`DEFAULT_PLAYER <simvx.core.input.players.DEFAULT_PLAYER>`
  - ```{autodoc2-docstring} simvx.core.input.players.DEFAULT_PLAYER
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.input.players.__all__
:value: >
   ['InputPlayer']

```{autodoc2-docstring} simvx.core.input.players.__all__
```

````

````{py:data} DEFAULT_PLAYER
:canonical: simvx.core.input.players.DEFAULT_PLAYER
:value: >
   0

```{autodoc2-docstring} simvx.core.input.players.DEFAULT_PLAYER
```

````

`````{py:class} InputPlayer(state: simvx.core.input.state._Input, player_id: int)
:canonical: simvx.core.input.players.InputPlayer

```{autodoc2-docstring} simvx.core.input.players.InputPlayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.input.players.InputPlayer.__slots__
:value: >
   ('_id', '_state', '_pads', '_desk')

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.__slots__
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.input.players.InputPlayer.__repr__

````

````{py:property} id
:canonical: simvx.core.input.players.InputPlayer.id
:type: int

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.id
```

````

````{py:property} is_default
:canonical: simvx.core.input.players.InputPlayer.is_default
:type: bool

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.is_default
```

````

````{py:property} devices
:canonical: simvx.core.input.players.InputPlayer.devices
:type: tuple[simvx.core.input.players.PairableDevice, ...]

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.devices
```

````

````{py:method} pair(device: simvx.core.input.players.PairableDevice) -> None
:canonical: simvx.core.input.players.InputPlayer.pair

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.pair
```

````

````{py:method} unpair(device: simvx.core.input.players.PairableDevice) -> None
:canonical: simvx.core.input.players.InputPlayer.unpair

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.unpair
```

````

````{py:method} owns(device: simvx.core.input.players.PairableDevice) -> bool
:canonical: simvx.core.input.players.InputPlayer.owns

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.owns
```

````

````{py:method} pressed(action: str) -> bool
:canonical: simvx.core.input.players.InputPlayer.pressed

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.pressed
```

````

````{py:method} just_pressed(action: str) -> bool
:canonical: simvx.core.input.players.InputPlayer.just_pressed

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.just_pressed
```

````

````{py:method} just_released(action: str) -> bool
:canonical: simvx.core.input.players.InputPlayer.just_released

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.just_released
```

````

````{py:method} value(action: str) -> bool | float | simvx.core.math.types.Vec2
:canonical: simvx.core.input.players.InputPlayer.value

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.value
```

````

````{py:method} get_action_strength(action: str) -> float
:canonical: simvx.core.input.players.InputPlayer.get_action_strength

```{autodoc2-docstring} simvx.core.input.players.InputPlayer.get_action_strength
```

````

`````