Guide 07

Gamepad settings

How to add Options › Gamepad on top of the keyboard menu: the same code for both devices, conflicts that know A means Ollie when skating and Accept in menus, and a prompt that listens to the controller.

GoalRebind any controller button, two per action, without breaking menu navigation for the person holding the controller.

Options &rsaquo; Gamepad: same menu script as the keyboard one, with Xbox names and icons. — Options › Gamepad: same menu script as the keyboard one, with Xbox names and icons.

1One binding engine, two device tables

p_keybindings became p_bindings: a table per device, plus where each action works.

diffWn32/Code/Plat/Sys/SIO/p_bindings.h · working tree

+	enum EBindingDevice
+	{
+		vBIND_KEYBOARD,
+		vBIND_GAMEPAD,
+		vNUM_BIND_DEVICES
+	};
+
+	// Where an action works. A key or button does one thing in each of these, so two actions can only
+	// share it if they never work in the same place (gamepad A is Ollie when skating and Accept in menus).
+	enum
+	{
+		mBIND_GAME			= 1 << 0,
+		mBIND_MENU			= 1 << 1,
+		mBIND_PARK_EDITOR	= 1 << 2,
+		mBIND_ANYWHERE		= mBIND_GAME | mBIND_MENU | mBIND_PARK_EDITOR,
+	};
-	SDL_Scancode GetKeyBinding(int action, int slot);
+	int GetBinding(EBindingDevice device, int action, int slot);

new fileWn32/Code/Plat/Sys/SIO/p_bindings.cpp

// The THUG1 Xbox layout. The face buttons mean one thing when skating (and in the park editor) and another in
// menus, where they're the Menus actions. The shoulders and triggers work everywhere.
static const sBindingAction s_pad_actions[vNUM_PAD_ACTIONS] = {
	{ "Ollie",			"Ollie",			vPG_SKATER,	mBIND_GAME | mBIND_PARK_EDITOR,	{ vPAD_INPUT_A } },
	{ "Grab",			"Grab/Talk",		vPG_SKATER,	mBIND_GAME | mBIND_PARK_EDITOR,	{ vPAD_INPUT_B } },
	{ "NollieSpinLeft",	"Nollie/Spin Left",	vPG_SKATER,	mBIND_ANYWHERE,					{ vPAD_INPUT_LEFT_TRIGGER } },
	{ "RetryGoal",		"Retry Goal",		vPG_SKATER,	mBIND_GAME | mBIND_PARK_EDITOR,	{ vPAD_INPUT_BACK } },
	{ "CameraView",		"Change View",		vPG_CAMERA,	mBIND_GAME,						{ } },
	{ "MenuAccept",		"Accept",			vPG_MENUS,	mBIND_MENU,						{ vPAD_INPUT_A } },
	{ "MenuBack",		"Back",				vPG_MENUS,	mBIND_MENU,						{ vPAD_INPUT_B, vPAD_INPUT_BACK } },
};

2Conflicts only where actions meet

excerptWn32/Code/Plat/Sys/SIO/p_bindings.cpp

// Whether the actions work in the same place, so they can't share a key / button
static bool ActionsOverlap(EBindingDevice device, int action, int other)
{
	const sBindingAction *p_actions = s_devices[device].p_actions;
	return (p_actions[action].contexts & p_actions[other].contexts) != 0;
}

int FindBindingConflict(EBindingDevice device, int action, int input)
{
	for (int other = 0; other < s_devices[device].num_actions; other++)
	{
		if (other == action || !ActionsOverlap(device, action, other))
			continue;
		...

Keyboard actions are all mBIND_ANYWHERE, so for keys this collapses to "one key, one action". Same code, two personalities.

3Rewrite the controller reader around bindings

Every input (buttons and both triggers) is read into a per-port table with its context; actions decide the PS2 bits. On a trigger, nollie/switch still press both halves only when pulled past halfway, like the Xbox.

diffWn32/Code/Plat/Sys/SIO/p_siodev.cpp · working tree

-	pad.cross |= button( SDL_CONTROLLER_BUTTON_A );
-	pad.square |= button( SDL_CONTROLLER_BUTTON_X );
-	pad.circle |= ( b.held && !b.HeldInMenu()) || y.HeldInMenu();
-	pad.triangle |= ( y.held && !y.HeldInMenu()) || b.HeldInMenu() || back.HeldInMenu();
-	pad.select |= back.held && !back.HeldInMenu();
+	pad.cross |= action_held( vPA_OLLIE ) || action_held( vPA_MENU_ACCEPT );
+	pad.square |= action_held( vPA_FLIP ) || action_held( vPA_MENU_DELETE );
+	pad.circle |= action_held( vPA_GRAB ) || action_held( vPA_MENU_SPACE );
+	pad.triangle |= action_held( vPA_GRIND ) || action_held( vPA_MENU_BACK );
+	pad.select |= action_held( vPA_RETRY_GOAL );

-	pad.l1 |= lt.HeldOutsideEditor() || rt.HeldIn( vCTX_PARK_EDITOR );
-	pad.l2 |= ( lt.HeldOutsideEditor() && left_trigger > trigger_full ) || lt.HeldIn( vCTX_PARK_EDITOR );
+	pad.l1 |= action_held( vPA_NOLLIE_SPIN_LEFT, mCTX_NOT_EDITOR ) || action_held( vPA_SWITCH_SPIN_RIGHT, mCTX_PARK_EDITOR );
+	pad.l2 |= action_full( vPA_NOLLIE_SPIN_LEFT, mCTX_NOT_EDITOR ) || action_held( vPA_NOLLIE_SPIN_LEFT, mCTX_PARK_EDITOR );

4Listen to the controller: fresh presses only

The A you pressed to open the prompt is still down when it opens. Only a button that goes down after counts; everything held is blocked until released. Start cancels, like Escape on the keyboard, and isn't bindable for that reason.

diffWn32/Code/Plat/Sys/SIO/p_siodev.cpp · working tree

+	// While binding a button, presses go to Options > Gamepad (Start cancels), and the controller does
+	// nothing else until the buttons are released
+	bool capturing = IsCapturingBinding( vBIND_GAMEPAD );
+	for( int input = vPAD_INPUT_NONE + 1; input < vNUM_PAD_INPUTS; input++ )
+	{
+		if( !down )
+			inputs.blocked[input] = false;
+		else if( capturing )
+		{
+			if( !inputs.down[input] )
+				CapturePadInput( (EPadInput)input );
+			inputs.blocked[input] = true;
+		}
+		inputs.down[input] = down;
+
+		inputs.inputs[input].Update( down && !inputs.blocked[input], context );
+	}

RB is Get Off Board while skating, so it conflicts with Grab. A Menus action wouldn't.

First version captured the A that opened the prompt. Every action got bound to A. Very consistent. Very useless.

5Rescue Select

Back used to send Select, which looked unused until panelstuff.q turned up: { pad_select goal_retry_select_handler }. It's the quick goal retry. It became an action (and a keyboard action too, unbound by default).

6One menu script for both devices

Script functions take a device; the menu sets a global and the same rows, prompt and dialogs serve both. X (Square in menus) clears the selected slot, so controller-only players can unbind too.

diffScripts/patches/levels/mainmenu/mainmenu_scripts.q · working tree

+SCRIPT create_gamepad_options_menu
+	Change binding_menu_device = 1
+	create_binding_options_menu title = "GAMEPAD"
+ENDSCRIPT
@@
+		SetScreenElementProps { id = <item_id> event_handlers = [
+				{ pad_square binding_options_clear params = { action = <action> } }
+			]
+		}

configGame/config.ini

[Gamepad]
; Two buttons per action: Action=button and Action2=second button, empty for none
; Skater
Ollie=A
NollieSpinLeft=LT
GetOffBoard=RB
RetryGoal=Back
; Menus
MenuAccept=A
MenuBack=B
MenuBack2=Back

FOR EDUCATION PURPOSES ONLY. Screenshots are captured from the port running the reader's own copy of the game. The diffs are trimmed to the interesting lines (unchanged context is cut, marked ⋯); the repository has the full changes. Paths are relative to the THUG/ folder.