Skip to content
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

add tooltip flag requirements #2320

Closed
wants to merge 2 commits into from
+41 −10
Closed

add tooltip flag requirements #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb64438
add tooltip flag requirements
SrRapero720 Feb 5, 2024
b60dca6
ignore first and second flags
SrRapero720 Feb 19, 2024
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
22 changes: 17 additions & 5 deletions src/main/java/net/caffeinemc/mods/sodium/client/gui/SodiumOptionsGUI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@
import java.io.IOException;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashSet;
import java.util.List;
import java.util.*;
import java.util.stream.Stream;

// TODO: Rename in Sodium 0.6
Expand Down Expand Up @@ -302,13 +299,28 @@ private void renderOptionTooltip(GuiGraphics graphics, ControlElement<?> element

Option<?> option = element.getOption();
List<FormattedCharSequence> tooltip = new ArrayList<>(this.font.split(option.getTooltip(), boxWidth - (textPadding * 2)));
List<FormattedCharSequence> tooltipDetails = new ArrayList<>();

OptionImpact impact = option.getImpact();

if (impact != null) {
tooltip.add(Language.getInstance().getVisualOrder(Component.translatable("sodium.options.performance_impact_string", impact.getLocalizedName()).withStyle(ChatFormatting.GRAY)));
tooltipDetails.add(Language.getInstance().getVisualOrder(Component.translatable("sodium.options.performance_impact_string", impact.getLocalizedName()).withStyle(ChatFormatting.GRAY)));
}

Collection<OptionFlag> flags = option.getFlags();

for (OptionFlag flag: flags) {
if (flag.ordinal() <= 1) continue; // ignore irrelevant flags
tooltipDetails.add(Language.getInstance().getVisualOrder(Component.translatable("sodium.options.flags_requirement_string", flag.getLocalizedName()).withStyle(ChatFormatting.GRAY)));
}

if (!tooltip.isEmpty() && !tooltipDetails.isEmpty()) {
tooltip.add(Language.getInstance().getVisualOrder(Component.literal("")));
}

tooltip.addAll(tooltipDetails);
tooltipDetails.clear();

int boxHeight = (tooltip.size() * 12) + boxPadding;
int boxYLimit = boxY + boxHeight;
int boxYCutoff = this.height - 40;
Expand Down
24 changes: 19 additions & 5 deletions src/main/java/net/caffeinemc/mods/sodium/client/gui/options/OptionFlag.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
package net.caffeinemc.mods.sodium.client.gui.options;

public enum OptionFlag {
REQUIRES_RENDERER_RELOAD,
REQUIRES_RENDERER_UPDATE,
REQUIRES_ASSET_RELOAD,
REQUIRES_GAME_RESTART
import net.minecraft.ChatFormatting;
import net.minecraft.network.chat.Component;

public enum OptionFlag implements TextProvider {
REQUIRES_RENDERER_RELOAD(ChatFormatting.GREEN, "sodium.options.flag_renderer_reload"),
REQUIRES_RENDERER_UPDATE(ChatFormatting.YELLOW, "sodium.options.flag_renderer_update"),
REQUIRES_ASSET_RELOAD(ChatFormatting.GOLD, "sodium.options.flag_assets_reload"),
REQUIRES_GAME_RESTART(ChatFormatting.RED, "sodium.options.flag_game_restart");

private final Component text;

OptionFlag(ChatFormatting color, String text) {
this.text = Component.translatable(text).withStyle(color);
}

@Override
public Component getLocalizedName() {
return this.text;
}
}
5 changes: 5 additions & 0 deletions src/main/resources/assets/sodium/lang/en_us.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@
"sodium.options.cpu_render_ahead_limit.tooltip": "For debugging only. Specifies the maximum number of frames which can be in-flight to the GPU. Changing this value is not recommended, as very low or high values may create frame rate instability.",
"sodium.options.cpu_render_ahead_limit.value": "%s frame(s)",
"sodium.options.performance_impact_string": "Performance Impact: %s",
"sodium.options.flags_requirement_string": "Requires: %s",
"sodium.options.flag_renderer_reload": "Renderer Reload",
"sodium.options.flag_renderer_update": "Renderer Refresh",
"sodium.options.flag_assets_reload" : "Assets Reload",
"sodium.options.flag_game_restart": "Game Restart",
"sodium.options.use_persistent_mapping.name": "Use Persistent Mapping",
"sodium.options.use_persistent_mapping.tooltip": "For debugging only. If enabled, persistent memory mappings will be used for the staging buffer so that unnecessary memory copies can be avoided. Disabling this can be useful for narrowing down the cause of graphical corruption.\n\nRequires OpenGL 4.4 or ARB_buffer_storage.",
"sodium.options.chunk_update_threads.name": "Chunk Update Threads",
Expand Down