nodes/controls.py

Part of GDQuest Open RPG.

"""What the player can do, declared once per mode and carried by a node.

The port has two modes and one context each. ``EXPLORING`` rides on the player,
so walking arrives with the player and leaves with them. ``BATTLE`` rides on the
battle scene and hides everything below it, which is what a modal fight means:
while it is on screen the overworld's names are dark and only the battle's own
answer. Nothing is registered from ``main()``, where ``InputMap`` has no tree yet
and which a test that loads one scene never calls.
"""

from __future__ import annotations

from simvx.core import Axis2D, Controller, DeviceAxis, InputBinding, InputContext, Key, Mouse


def _stick_half(axis: DeviceAxis, positive: bool) -> InputBinding:
    """One direction of a stick as a button, for a cursor that steps."""
    return InputBinding(axis.positive if positive else axis.negative, deadzone=0.5)


#: Actions every screen needs. This is the root's own context, so it covers the
#: whole tree while the root is mounted. ``advance`` takes a tap as well as a key
#: and a face button, because the web runtime delivers touch as a left click and
#: a pad player has to be able to leave the title card too.
SHELL = {
    "advance": [Key.ENTER, Key.SPACE, Key.E, Mouse.LEFT, Controller.A, Controller.START],
    "quit": [Key.Q, Controller.BACK],
}

#: Walking the overworld. Movement is one typed action rather than four, so the
#: keys, the arrows, a controller's D-pad and left stick and the drawn pad all
#: feed it and the source furthest from rest wins. ``Input.value("move")`` is a
#: ``Vec2``; the player rounds it to the one tile step it is asking for.
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),
            Axis2D(
                up=Controller.DPAD_UP,
                down=Controller.DPAD_DOWN,
                left=Controller.DPAD_LEFT,
                right=Controller.DPAD_RIGHT,
            ),
            Controller.LEFT_STICK,
        ],
        "interact": [Key.E, Controller.A],
        "walk_to": [Mouse.LEFT],
    },
    name="exploring",
)

#: Fighting. The menu cursor steps, so its four directions are buttons rather
#: than one vector: a stick half past its deadzone counts as a press, the same
#: as an arrow key or a D-pad direction. ``confirm`` deliberately leaves the left
#: button to ``select``, which carries a position: a tap picks the row or the foe
#: it landed on rather than whatever the cursor was sitting over.
BATTLE = InputContext(
    {
        "advance": [Key.ENTER, Key.SPACE, Mouse.LEFT, Controller.A],
        "menu_up": [Key.W, Key.UP, Controller.DPAD_UP, _stick_half(Controller.LEFT_Y, False)],
        "menu_down": [Key.S, Key.DOWN, Controller.DPAD_DOWN, _stick_half(Controller.LEFT_Y, True)],
        "menu_left": [Key.A, Key.LEFT, Controller.DPAD_LEFT, _stick_half(Controller.LEFT_X, False)],
        "menu_right": [Key.D, Key.RIGHT, Controller.DPAD_RIGHT, _stick_half(Controller.LEFT_X, True)],
        "confirm": [Key.ENTER, Key.SPACE, Controller.A],
        "cancel": [Key.ESCAPE, Key.X, Controller.B],
        "select": [Mouse.LEFT],
    },
    name="battle",
    hides=InputContext.ALL,
)