controls.py

Part of Clear Code Zelda.

"""What the player can do, declared once and carried by the nodes that read it.

The gameplay verbs live on an :class:`InputContext` the player node holds, so
they are live exactly while the player is in the tree and go away with it. The
shell and menu actions sit on the scene root's ``input_context``, which is in
force while that root is mounted, whether by ``set_root`` or ``change_scene``, so a headless run,
a web export and a test that loads one scene all get them without anybody
calling a setup function.

The pad mapping is the one a controller player expects from a top-down action
game: A swings, B casts, the shoulders cycle the weapon and the spell, and
Start opens the upgrade screen.
"""

from __future__ import annotations

from simvx.core import Axis1D, Axis2D, Controller, InputContext, Key, Mouse

#: Walking and fighting. Movement is one typed action rather than four opposed
#: ones, so WASD, the arrows, a controller's left stick and the drawn pad's
#: stick all feed it and whichever is furthest from rest wins.
EXPLORING = InputContext(
    {
        "move": [
            Axis2D(up=Key.W, down=Key.S, left=Key.A, right=Key.D),
            Axis2D(up=Key.UP, down=Key.DOWN, left=Key.LEFT, right=Key.RIGHT),
            Controller.LEFT_STICK,
        ],
        "attack": [Key.SPACE, Controller.A],
        "magic": [Key.LEFT_CONTROL, Key.RIGHT_CONTROL, Controller.B],
        "weapon_swap": [Key.Q, Controller.LEFT_BUMPER],
        "magic_swap": [Key.E, Controller.RIGHT_BUMPER],
    },
    name="exploring",
)

#: What stays available whatever is on screen: leaving the title card, opening
#: and closing the upgrade screen, driving it, and quitting. A tap counts for
#: starting because the web runtime delivers touch as a left click, and every
#: one of them has a pad spelling so a controller never has to be put down.
SHELL = {
    "start": [Key.ENTER, Key.SPACE, Mouse.LEFT, Controller.A, Controller.START],
    "upgrade_menu": [Key.M, Controller.START],
    "ui_nav": [
        Axis1D(low=Key.LEFT, high=Key.RIGHT),
        Axis1D(low=Key.A, high=Key.D),
        Controller.LEFT_X,
    ],
    "ui_select": [Key.SPACE, Key.ENTER, Controller.A],
    "ui_cancel": [Controller.B],
    "quit": [Key.ESCAPE],
}