Module: RGame::Util::Controls

Defined in:: lib/rgame/util/controls.rb

Overview

The vocabulary of physical inputs: which integer means "the left arrow key", "the A button", "the left stick's X axis", "player 2's controller".

These are values — plain integers with no window, GPU or OS handle behind them — so they live in Util rather than Core. That is what lets the engine layer and a game's own configuration name a physical input without touching RGame::Core, which they may not do:

controls = RGame::Util::Controls
map = RGame::Engine::InputMap.default.merge(
fire: { buttons: [controls::KEY_SPACE, controls::PAD_A] }
)

This module is the vocabulary only. What an id means to a game — the binding table — is RGame::Engine::InputMap, one per player, because two players share a game's actions but not the buttons that trigger them.

The same numbers exist as #defines in ext/rgame_core/include/rgame/core.h, because the C engine and the standalone binary need them too and cannot see Ruby. Two definitions means a drift risk, so it is checked: the C side is tied to SDL's own scancodes by _Static_assert at compile time, and spec/rgame/util/controls_spec.rb parses that header and compares every value here against it.

Constant Summary collapse

KEY_A = Letters. Scancodes are physical positions, so KEY_A is the key marked A on a QWERTY board and Q on AZERTY.

KEY_B =

KEY_C =

KEY_D =

KEY_E =

KEY_F =

KEY_G =

KEY_H =

KEY_I =

KEY_J =

KEY_K =

KEY_L =

KEY_M =

KEY_N =

KEY_O =

KEY_P =

KEY_Q =

KEY_R =

KEY_S =

KEY_T =

KEY_U =

KEY_V =

KEY_W =

KEY_X =

KEY_Y =

KEY_Z =

KEY_1 = Digits along the top row.

KEY_2 =

KEY_3 =

KEY_4 =

KEY_5 =

KEY_6 =

KEY_7 =

KEY_8 =

KEY_9 =

KEY_0 =

KEY_RETURN = Editing and whitespace.

KEY_ESCAPE =

KEY_BACKSPACE =

KEY_TAB =

KEY_SPACE =

KEY_MINUS = Punctuation, by position on a US board.

KEY_EQUALS =

KEY_LEFTBRACKET =

KEY_RIGHTBRACKET =

KEY_BACKSLASH =

KEY_SEMICOLON =

KEY_APOSTROPHE =

KEY_GRAVE =

KEY_COMMA =

KEY_PERIOD =

KEY_SLASH =

KEY_CAPSLOCK = Function row and caps lock.

KEY_F1 =

KEY_F2 =

KEY_F3 =

KEY_F4 =

KEY_F5 =

KEY_F6 =

KEY_F7 =

KEY_F8 =

KEY_F9 =

KEY_F10 =

KEY_F11 =

KEY_F12 =

KEY_INSERT = The navigation cluster.

KEY_HOME =

KEY_PAGEUP =

KEY_DELETE =

KEY_END =

KEY_PAGEDOWN =

KEY_RIGHT = Arrows.

KEY_LEFT =

KEY_DOWN =

KEY_UP =

KEY_LCTRL = Modifiers. No GUI key: that is Windows on a PC and Command on a Mac, which is exactly the platform-specific territory this list stays out of.

KEY_LSHIFT =

KEY_LALT =

KEY_RCTRL =

KEY_RSHIFT =

KEY_RALT =

PAD_A = --- Gamepad buttons. The gamepad range plus SDL's own controller button number. The first fifteen are on every controller; MISC1, the paddles and TOUCHPAD are hardware the id space describes but most pads do not have, and read as never pressed on one that does not. ---

PAD_B =

PAD_X =

PAD_Y =

PAD_BACK =

PAD_GUIDE =

PAD_START =

PAD_LEFT_STICK =

PAD_RIGHT_STICK =

PAD_LEFT_SHOULDER =

PAD_RIGHT_SHOULDER =

PAD_DPAD_UP =

PAD_DPAD_DOWN =

PAD_DPAD_LEFT =

PAD_DPAD_RIGHT =

PAD_MISC1 =

PAD_PADDLE1 =

PAD_PADDLE2 =

PAD_PADDLE3 =

PAD_PADDLE4 =

PAD_TOUCHPAD =

AXIS_LEFT_X = --- Analog axes. Their own small space: they are float-valued and read through a different call, so folding them into the button space would only invite asking for an axis as if it were a button. ---

AXIS_LEFT_Y =

AXIS_RIGHT_X =

AXIS_RIGHT_Y =

AXIS_TRIGGER_LEFT =

AXIS_TRIGGER_RIGHT =

KEYBOARD = --- Devices. The keyboard is 0 so single-player code can leave it out; gamepads follow, one per player slot. ---

GAMEPAD_FIRST =

MAX_GAMEPADS =

Class Method Summary collapse

.gamepad(slot) ⇒ Object
The device id for a player slot: gamepad(0) is the first controller.

Class Method Details

.gamepad(slot) ⇒ `Object`

The device id for a player slot: gamepad(0) is the first controller.