Skip to content

Make unit select and command rebindable #3116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
burnhamrobertp wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Make unit select and command rebindable #3116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
66d00ec
Let a mouse-button binding override the built-in select/command
burnhamrobertp Jul 16, 2026
75cd72d
Drop AI comments from the mouse-button bind loops
burnhamrobertp Jul 17, 2026
a25d5d5
Extract MousePress consumer checks into named helpers
burnhamrobertp Jul 17, 2026
76ef3cd
Drop the mouse-button MousePress override
burnhamrobertp Jul 17, 2026
01ebfba
Drive unit select/command off bindable mouse-role actions
burnhamrobertp Jul 17, 2026
975562c
Replace stale left/right comments and names with role terms
burnhamrobertp Jul 18, 2026
01eab76
Correct the stale rightMouseButton comment in the command spoof
burnhamrobertp Jul 18, 2026
47130fb
Resolve Lua command role, cache role masks, fix receiver clear
burnhamrobertp Jul 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 57 additions & 44 deletions rts/Game/UI/GuiHandler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ void CGuiHandler::LayoutIcons(bool useSelectionPage)
SCommandDescription cmdDesc;
{
defCmd =
(mouse->buttons[SDL_BUTTON_RIGHT].pressed &&
(mouse->IsActionButtonPressed("mousesecondary") &&
(defaultCmdMemory >= 0) && (inCommand < 0) &&
((activeReceiver == this) || (minimap->ProxyMode())));

Expand Down Expand Up @@ -1124,7 +1124,7 @@ void CGuiHandler::SetCursorIcon() const
else if (!useMinimap || minimap->FullProxy()) {
int defcmd;

if (mouse->buttons[SDL_BUTTON_RIGHT].pressed && ((activeReceiver == this) || (minimap->ProxyMode()))) {
if (mouse->IsActionButtonPressed("mousesecondary") && ((activeReceiver == this) || (minimap->ProxyMode()))) {
defcmd = defaultCmdMemory;
} else {
defcmd = GetDefaultCommand(mouse->lastx, mouse->lasty);
Expand Down Expand Up @@ -1205,7 +1205,8 @@ bool CGuiHandler::MousePress(int x, int y, int button)
{
RECOIL_DETAILED_TRACY_ZONE;
{
if (button != SDL_BUTTON_LEFT && button != SDL_BUTTON_RIGHT && button != -SDL_BUTTON_RIGHT && button != -SDL_BUTTON_LEFT)
const int roleButton = (button < 0) ? -button : button;
if (!mouse->IsButtonBoundToAction(roleButton, "mouseprimary") && !mouse->IsButtonBoundToAction(roleButton, "mousesecondary"))
return false;

if (button < 0) {
Expand All @@ -1221,7 +1222,7 @@ bool CGuiHandler::MousePress(int x, int y, int button)
curIconCommand = icons[iconPos].commandsID;
}
}
if (button == SDL_BUTTON_RIGHT)
if (mouse->IsButtonBoundToAction(button, "mousesecondary"))
SetActiveCommandIndex(defaultCmdMemory = -1);
return true;
}
Expand All @@ -1230,8 +1231,8 @@ bool CGuiHandler::MousePress(int x, int y, int button)
}

if (inCommand >= 0) {
if (invertQueueKey && (button == SDL_BUTTON_RIGHT) &&
!mouse->buttons[SDL_BUTTON_LEFT].pressed) { // for rocker gestures
if (invertQueueKey && mouse->IsButtonBoundToAction(button, "mousesecondary") &&
!mouse->IsActionButtonPressed("mouseprimary")) { // for rocker gestures
SetActiveCommandIndex(-1);
needShift = false;
return false;
Expand All @@ -1240,7 +1241,7 @@ bool CGuiHandler::MousePress(int x, int y, int button)
return true;
}
}
if (button == SDL_BUTTON_RIGHT) {
if (mouse->IsButtonBoundToAction(button, "mousesecondary")) {
activeMousePress = true;
defaultCmdMemory = GetDefaultCommand(x, y);
return true;
Expand All @@ -1253,7 +1254,8 @@ bool CGuiHandler::MousePress(int x, int y, int button)
void CGuiHandler::MouseRelease(int x, int y, int button, const float3& cameraPos, const float3& mouseDir)
{
RECOIL_DETAILED_TRACY_ZONE;
if (button != SDL_BUTTON_LEFT && button != SDL_BUTTON_RIGHT && button != -SDL_BUTTON_RIGHT && button != -SDL_BUTTON_LEFT)
const int roleButton = (button < 0) ? -button : button;
if (!mouse->IsButtonBoundToAction(roleButton, "mouseprimary") && !mouse->IsButtonBoundToAction(roleButton, "mousesecondary"))
return;

int lastIconCmd = curIconCommand;
Expand Down Expand Up @@ -1285,14 +1287,14 @@ void CGuiHandler::MouseRelease(int x, int y, int button, const float3& cameraPos
}
}

if ((button == SDL_BUTTON_RIGHT) && (iconCmd == -1)) {
// right click -> set the default cmd
if (mouse->IsButtonBoundToAction(button, "mousesecondary") && (iconCmd == -1)) {
// command-role button -> set the default cmd
SetActiveCommandIndex(defaultCmdMemory);
defaultCmdMemory = -1;
}

if (size_t(iconCmd) < commands.size()) {
SetActiveCommand(iconCmd, button == SDL_BUTTON_RIGHT);
SetActiveCommand(iconCmd, mouse->IsButtonBoundToAction(button, "mousesecondary"));
return;
}

Expand Down Expand Up @@ -1416,35 +1418,39 @@ bool CGuiHandler::SetActiveCommand(int cmdIndex, int button,
bool alt, bool ctrl, bool meta, bool shift)
{
RECOIL_DETAILED_TRACY_ZONE;
// use the button value instead of rightMouseButton
const bool effectiveRMB = (button == SDL_BUTTON_LEFT) ? false : true;
// derive the command flag from the button's role, not the passed rightMouseButton
const bool effectiveSecondary = !mouse->IsButtonBoundToAction(button, "mouseprimary");

// spoof state on whichever buttons carry the select/command roles
const int selectButton = mouse->GetActionButton("mouseprimary");
const int commandButton = mouse->GetActionButton("mousesecondary");

// setup the mouse and key states
const bool prevLMB = mouse->buttons[SDL_BUTTON_LEFT].pressed;
const bool prevRMB = mouse->buttons[SDL_BUTTON_RIGHT].pressed;
const bool prevPrimary = (selectButton > 0) && mouse->buttons[selectButton ].pressed;
const bool prevSecondary = (commandButton > 0) && mouse->buttons[commandButton].pressed;
const std::uint8_t prevAlt = KeyInput::GetKeyModState(KMOD_ALT);
const std::uint8_t prevCtrl = KeyInput::GetKeyModState(KMOD_CTRL);
const std::uint8_t prevMeta = KeyInput::GetKeyModState(KMOD_GUI);
const std::uint8_t prevShift = KeyInput::GetKeyModState(KMOD_SHIFT);

mouse->buttons[SDL_BUTTON_LEFT].pressed = leftMouseButton;
mouse->buttons[SDL_BUTTON_RIGHT].pressed = rightMouseButton;
if (selectButton > 0) mouse->buttons[selectButton ].pressed = leftMouseButton;
if (commandButton > 0) mouse->buttons[commandButton].pressed = rightMouseButton;

KeyInput::SetKeyModState(KMOD_ALT, alt);
KeyInput::SetKeyModState(KMOD_CTRL, ctrl);
KeyInput::SetKeyModState(KMOD_GUI, meta);
KeyInput::SetKeyModState(KMOD_SHIFT, shift);

const bool retval = SetActiveCommand(cmdIndex, effectiveRMB);
const bool retval = SetActiveCommand(cmdIndex, effectiveSecondary);

// revert the mouse and key states
KeyInput::SetKeyModState(KMOD_SHIFT, prevShift);
KeyInput::SetKeyModState(KMOD_GUI, prevMeta);
KeyInput::SetKeyModState(KMOD_CTRL, prevCtrl);
KeyInput::SetKeyModState(KMOD_ALT, prevAlt);

mouse->buttons[SDL_BUTTON_RIGHT].pressed = prevRMB;
mouse->buttons[SDL_BUTTON_LEFT].pressed = prevLMB;
if (commandButton > 0) mouse->buttons[commandButton].pressed = prevSecondary;
if (selectButton > 0) mouse->buttons[selectButton ].pressed = prevPrimary;

return retval;
}
Expand Down Expand Up @@ -1642,8 +1648,8 @@ unsigned char CGuiHandler::CreateOptions(bool rightMouseButton)
// allow mouse button 'rocker' movements to force
// immediate mode (when queuing is the default mode)
if (!invertQueueKey ||
(!mouse->buttons[SDL_BUTTON_LEFT].pressed &&
!mouse->buttons[SDL_BUTTON_RIGHT].pressed)) {
(!mouse->IsActionButtonPressed("mouseprimary") &&
!mouse->IsActionButtonPressed("mousesecondary"))) {
options |= SHIFT_KEY;
}
}
Expand All @@ -1656,7 +1662,7 @@ unsigned char CGuiHandler::CreateOptions(bool rightMouseButton)
unsigned char CGuiHandler::CreateOptions(int button)
{
RECOIL_DETAILED_TRACY_ZONE;
return CreateOptions(button != SDL_BUTTON_LEFT);
return CreateOptions(!mouse->IsButtonBoundToAction(button, "mouseprimary"));
}


Expand Down Expand Up @@ -2071,7 +2077,7 @@ bool CGuiHandler::KeyReleased(int keyCode, int scanCode)

void CGuiHandler::FinishCommand(int button)
{
if ((button == SDL_BUTTON_LEFT) && (KeyInput::GetKeyModState(KMOD_SHIFT) || invertQueueKey)) {
if (mouse->IsButtonBoundToAction(button, "mouseprimary") && (KeyInput::GetKeyModState(KMOD_SHIFT) || invertQueueKey)) {
needShift = true;
} else {
SetActiveCommandIndex(-1);
Expand Down Expand Up @@ -2177,17 +2183,19 @@ Command CGuiHandler::GetCommand(int mouseX, int mouseY, int buttonHint, bool pre
if (buttonHint >= SDL_BUTTON_LEFT) {
button = buttonHint;
} else if (inCommand != -1) {
button = SDL_BUTTON_LEFT;
} else if (mouse->buttons[SDL_BUTTON_RIGHT].pressed) {
button = SDL_BUTTON_RIGHT;
button = mouse->GetActionButton("mouseprimary");
if (button < 0)
button = SDL_BUTTON_LEFT;
} else if (mouse->IsActionButtonPressed("mousesecondary")) {
button = mouse->GetPressedActionButton("mousesecondary");
} else {
return Command(CMD_STOP);
}

if (button == SDL_BUTTON_RIGHT && preview) {
// right click -> default cmd
if (mouse->IsButtonBoundToAction(button, "mousesecondary") && preview) {
// command-role button -> default cmd
// (in preview we might not have default cmd memory set)
if (mouse->buttons[SDL_BUTTON_RIGHT].pressed) {
if (mouse->IsActionButtonPressed("mousesecondary")) {
tempInCommand = defaultCmdMemory;
} else {
tempInCommand = GetDefaultCommand(mouseX, mouseY, cameraPos, mouseDir);
Expand All @@ -2208,8 +2216,8 @@ Command CGuiHandler::GetCommand(int mouseX, int mouseY, int buttonHint, bool pre

case CMDTYPE_ICON: {
Command c(commands[tempInCommand].id, CreateOptions(button));
if (button == SDL_BUTTON_LEFT && !preview)
LOG_L(L_WARNING, "CMDTYPE_ICON left button press in incommand test? This should not happen.");
if (mouse->IsButtonBoundToAction(button, "mouseprimary") && !preview)
LOG_L(L_WARNING, "CMDTYPE_ICON primary-role button press in incommand test? This should not happen.");

return CheckCommand(c);
}
Expand All @@ -2236,9 +2244,9 @@ Command CGuiHandler::GetCommand(int mouseX, int mouseY, int buttonHint, bool pre

const BuildInfo bi(unitdef, cameraPos + mouseDir * dist, buildFacing);

if (GetQueueKeystate() && (button == SDL_BUTTON_LEFT)) {
const float3 camTracePos = mouse->buttons[SDL_BUTTON_LEFT].camPos;
const float3 camTraceDir = mouse->buttons[SDL_BUTTON_LEFT].dir;
if (GetQueueKeystate() && mouse->IsButtonBoundToAction(button, "mouseprimary")) {
const float3 camTracePos = mouse->buttons[button].camPos;
const float3 camTraceDir = mouse->buttons[button].dir;

const float traceDist = camera->GetFarPlaneDist() * 1.4f;
const float isectDist = CGround::LineGroundWaterCol(camTracePos, camTraceDir, traceDist, unitdef->floatOnWater, false);
Expand Down Expand Up @@ -3035,7 +3043,7 @@ void CGuiHandler::DrawHilightQuad(const IconInfo& icon)
RECOIL_DETAILED_TRACY_ZONE;
if (icon.commandsID == inCommand) {
glColor4f(0.3f, 0.0f, 0.0f, 1.0f);
} else if (mouse->buttons[SDL_BUTTON_LEFT].pressed) {
} else if (mouse->IsActionButtonPressed("mouseprimary")) {
glColor4f(0.2f, 0.0f, 0.0f, 1.0f);
} else {
glColor4f(0.0f, 0.0f, 0.2f, 1.0f);
Expand Down Expand Up @@ -3179,8 +3187,8 @@ void CGuiHandler::DrawButtons() // Only called by Draw
if (highlight) {
if (icon.commandsID == inCommand) {
glColor4f(1.0f, 1.0f, 0.0f, 0.75f);
} else if (mouse->buttons[SDL_BUTTON_LEFT].pressed ||
mouse->buttons[SDL_BUTTON_RIGHT].pressed) {
} else if (mouse->IsActionButtonPressed("mouseprimary") ||
mouse->IsActionButtonPressed("mousesecondary")) {
glColor4f(1.0f, 0.0f, 0.0f, 0.50f);
} else {
glColor4f(1.0f, 1.0f, 1.0f, 0.50f);
Expand Down Expand Up @@ -3575,15 +3583,19 @@ void CGuiHandler::DrawMapStuff(bool onMiniMap)

if (activeMousePress) {
int cmdIndex = -1;
int button = SDL_BUTTON_LEFT;
int button = mouse->GetPressedActionButton("mouseprimary");
if (button < 0)
button = mouse->GetActionButton("mouseprimary");
if (button < 0)
button = SDL_BUTTON_LEFT;

if (size_t(inCommand) < commands.size()) {
cmdIndex = inCommand;
} else {
if (mouse->buttons[SDL_BUTTON_RIGHT].pressed &&
if (mouse->IsActionButtonPressed("mousesecondary") &&
((activeReceiver == this) || (minimap->ProxyMode()))) {
cmdIndex = defaultCmdMemory;
button = SDL_BUTTON_RIGHT;
button = mouse->GetPressedActionButton("mousesecondary");
}
}

Expand Down Expand Up @@ -3818,8 +3830,9 @@ void CGuiHandler::DrawMapStuff(bool onMiniMap)
// get the build information
const float3 cPos = tracePos + traceDir * rayTraceDist;

const CMouseHandler::ButtonPressEvt& bp = mouse->buttons[SDL_BUTTON_LEFT];
if (GetQueueKeystate() && bp.pressed) {
const int selBtn = mouse->GetPressedActionButton("mouseprimary");
const CMouseHandler::ButtonPressEvt& bp = mouse->buttons[(selBtn > 0) ? selBtn : SDL_BUTTON_LEFT];
if (GetQueueKeystate() && (selBtn > 0) && bp.pressed) {
const float bpDist = CGround::LineGroundWaterCol(bp.camPos, bp.dir, maxTraceDist, buildeeDef->floatOnWater, false);
const float3 bPos = bp.camPos + bp.dir * bpDist;
const BuildInfo cInfo = BuildInfo(buildeeDef, cPos, buildFacing);
Expand Down Expand Up @@ -4003,7 +4016,7 @@ void CGuiHandler::DrawCentroidCursor()
} else {
size_t defcmd = 0;

if (mouse->buttons[SDL_BUTTON_RIGHT].pressed && ((activeReceiver == this) || (minimap->ProxyMode()))) {
if (mouse->IsActionButtonPressed("mousesecondary") && ((activeReceiver == this) || (minimap->ProxyMode()))) {
defcmd = defaultCmdMemory;
} else {
defcmd = GetDefaultCommand(mouse->lastx, mouse->lasty);
Expand Down
3 changes: 3 additions & 0 deletions rts/Game/UI/KeyBindings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ static const DefaultBinding defaultBindings[] = {
{ "Alt+Shift+esc", "reloadforce" },
{ "Any+pause", "pause" },

{ "Any+mouse1", "mouseprimary" },
{ "Any+mouse3", "mousesecondary" },

{ "c", "controlunit" },
{ "Any+h", "sharedialog" },
{ "Any+i", "gameinfo" },
Expand Down
2 changes: 1 addition & 1 deletion rts/Game/UI/KeyCodes.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ void CKeyCodes::Reset()
//AddPair("euro", SDLK_EURO); // Some european keyboards
//AddPair("undo", SDLK_UNDO); // Atari keyboard has Undo

for (int i = ACTION_BUTTON_MIN; i <= NUM_BUTTONS; i++) {
for (int i = 1; i <= NUM_BUTTONS; i++) {
AddPair("mouse" + IntToString(i), CKeyCodes::GetMouseButtonSymbol(i));
}

Expand Down
Loading
Loading