Skip to content

fix(ui): only play a json ui click sound when the control declares one #71

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

Merged
notchyves merged 1 commit into from
Nov 6, 2026
+37 −37
Merged

fix(ui): only play a json ui click sound when the control declares one #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 5 additions & 9 deletions src/client/PerlinWorldRender.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1691,15 +1691,11 @@ namespace perlin {
this->input.SetKeyboard(keyboard);
}
const bool pressed = this->input.IsMouseDown(0);
const bool onButton = hud->Overlay().OverlayHoverIsButton();
if (pressed && !uiClickWasDown && onButton && !chat.IsOpen()) {
std::string clickName = "random.click";
float clickVolume = 1.0f, clickPitch = 1.0f;
hud->Overlay().OverlayHoverSound(clickName, clickVolume, clickPitch);
if (!clickName.empty())
sounds.PlayNamed(clickName, {camera.x, camera.y, camera.z}, clickVolume, clickPitch,
false);
}
std::string clickName;
float clickVolume = 1.0f, clickPitch = 1.0f;
if (pressed && !uiClickWasDown && !chat.IsOpen() &&
hud->Overlay().OverlayHoverClickSound(clickName, clickVolume, clickPitch))
sounds.PlayNamed(clickName, {camera.x, camera.y, camera.z}, clickVolume, clickPitch, false);
uiClickWasDown = pressed;
}
DrawModTint(fbW, fbH);
Expand Down
36 changes: 16 additions & 20 deletions src/client/ui/RmlBackend.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -949,33 +949,29 @@ namespace perlin::ui {
return {};
}

bool RmlBackend::OverlayHoverIsButton() const {
bool RmlBackend::OverlayHoverClickSound(std::string& name, float& volume, float& pitch) const {
if (!context || !overlay)
return false;
static const char* const kClickable[] = {"btn", "sbtn", "rbtn", "pg", "row",
"ticon", "go", "acc", "bt"};
static const char* const kNative[] = {"btn", "sbtn", "rbtn", "pg", "row", "ticon", "go", "acc"};
for (Rml::Element* e = context->GetHoverElement(); e && e->GetOwnerDocument() == overlay;
e = e->GetParentNode()) {
if (e->IsClassSet("off"))
return false;
for (const char* name : kClickable)
if (e->IsClassSet(name))
if (e->HasAttribute("snd")) {
name = e->GetAttribute<Rml::String>("snd", "");
volume = e->GetAttribute<float>("vol", 1.0f);
pitch = e->GetAttribute<float>("pit", 1.0f);
return !name.empty();
}
// json ui control without sound_name (container slots, sliders, edit boxes): the game stays silent
if (e->IsClassSet("bt"))
return false;
for (const char* cls : kNative)
if (e->IsClassSet(cls)) {
name = "random.click";
volume = pitch = 1.0f;
return true;
}
return false;
}

bool RmlBackend::OverlayHoverSound(std::string& name, float& volume, float& pitch) const {
if (!context || !overlay)
return false;
for (Rml::Element* e = context->GetHoverElement(); e && e->GetOwnerDocument() == overlay;
e = e->GetParentNode()) {
if (!e->HasAttribute("snd"))
continue;
name = e->GetAttribute<Rml::String>("snd", "");
volume = e->GetAttribute<float>("vol", 1.0f);
pitch = e->GetAttribute<float>("pit", 1.0f);
return true;
}
}
return false;
}
Expand Down
4 changes: 2 additions & 2 deletions src/client/ui/RmlBackend.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ namespace perlin::ui {
bool HasOverlay() const { return overlay != nullptr; }
void MouseMove(float guiX, float guiY);
std::string OverlayHover() const;
bool OverlayHoverIsButton() const;
bool OverlayHoverSound(std::string& name, float& volume, float& pitch) const;
// sound to play for a click on the hovered overlay element; false when it makes none
bool OverlayHoverClickSound(std::string& name, float& volume, float& pitch) const;
std::string HoverLink() const;
void Update();
void Render();
Expand Down
20 changes: 14 additions & 6 deletions src/client/ui/RmlEmit.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,16 +442,23 @@ namespace perlin::ui {
}
}

namespace {
// sound_name after inheritance: common.button and toggles declare random.click, container slot buttons none
std::string SoundAttrs(const LNode& n) {
const Json* sn = n.Get("sound_name");
if (!sn || !sn->IsString())
return {};
return " snd=\"" + EscapeRml(sn->string) + "\" vol=\"" + Num(static_cast<float>(n.Num("sound_volume", 1.0))) +
"\" pit=\"" + Num(static_cast<float>(n.Num("sound_pitch", 1.0))) + "\"";
}
}

void RmlEmitter::VisitButton(const LNode& n, RmlWriter& out) {
const std::string command = ButtonCommand(n);
const std::string defName = n.Str("default_control"), hoverName = n.Str("hover_control"),
pressedName = n.Str("pressed_control"), lockedName = n.Str("locked_control");
const bool hasHover = FindKid(n, hoverName) != nullptr && (!command.empty() || inSlot);
std::string soundAttrs;
if (const Json* sn = n.Get("sound_name"); sn && sn->IsString())
soundAttrs = " snd=\"" + EscapeRml(sn->string) + "\" vol=\"" +
Num(static_cast<float>(n.Num("sound_volume", 1.0))) + "\" pit=\"" +
Num(static_cast<float>(n.Num("sound_pitch", 1.0))) + "\"";
const std::string soundAttrs = SoundAttrs(n);
out.BeginBox(n.ax, n.ay, n.w, n.h, TopLayer(n), command.empty() && !inSlot ? "" : "bt", command, false, 0.0f,
command.empty() && !inSlot ? std::string() : soundAttrs);
for (const auto& kid : n.kids) {
Expand Down Expand Up @@ -515,7 +522,8 @@ namespace perlin::ui {
states.push_back(std::move(name));
const std::string command = WidgetCommand(n);
const bool hasHover = !hover.empty() && FindKid(n, hover) != nullptr && !command.empty();
out.BeginBox(n.ax, n.ay, n.w, n.h, TopLayer(n), command.empty() ? "" : "bt", command, false);
out.BeginBox(n.ax, n.ay, n.w, n.h, TopLayer(n), command.empty() ? "" : "bt", command, false, 0.0f,
command.empty() ? std::string() : SoundAttrs(n));
for (const auto& kid : n.kids) {
if (!kid->visible)
continue;
Expand Down
Loading