# {py:mod}`simvx.core.ui.gamepad_overlay`

```{py:module} simvx.core.ui.gamepad_overlay
```

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`GamepadOverlay <simvx.core.ui.gamepad_overlay.GamepadOverlay>`
  - ```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.ui.gamepad_overlay.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.ui.gamepad_overlay.__all__
:value: >
   ['GamepadOverlay']

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.__all__
```

````

`````{py:class} GamepadOverlay(*, ability_keys: typing.Iterable[simvx.core.input.Key] = (Key.KEY_1, Key.KEY_2, Key.KEY_3, Key.KEY_4), primary_keys: typing.Iterable[simvx.core.input.Key] = (Key.SPACE, Key.E), secondary_key: simvx.core.input.Key = Key.LEFT_SHIFT, menu_key: simvx.core.input.Key = Key.ESCAPE, inventory_key: simvx.core.input.Key = Key.I, hotbar_keys: typing.Iterable[simvx.core.input.Key] = (Key.KEY_1, Key.KEY_2, Key.KEY_3, Key.KEY_4), primary_label: str = 'ATK', secondary_label: str = 'DODGE', menu_label: str = 'MENU', inventory_label: str = 'ITEMS')
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.__init__
```

````{py:method} configure(screen_w: int, screen_h: int, mobile: bool = False) -> None
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.configure

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.configure
```

````

````{py:property} visible
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.visible
:type: bool

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.visible
```

````

````{py:method} set_context(*, has_shield: bool = False, near_interactable: bool = False, in_menu: bool = False) -> None
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.set_context

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.set_context
```

````

````{py:property} joystick_value
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.joystick_value
:type: simvx.core.math.types.Vec2

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.joystick_value
```

````

````{py:method} on_process(dt: float) -> None
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.on_process

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.on_process
```

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.ui.gamepad_overlay.GamepadOverlay.on_draw

```{autodoc2-docstring} simvx.core.ui.gamepad_overlay.GamepadOverlay.on_draw
```

````

`````