Extract CClient strings to constants (#2042)

Making it uniform with other config classes using static string holders.
This commit is contained in:
Tooster 2021-09-13 17:28:29 +02:00 committed by GitHub
parent 6800c24c58
commit 72a8e24cf7
Failed to generate hash of commit

View file

@ -5,70 +5,73 @@ import com.simibubi.create.foundation.config.ui.ConfigAnnotations;
public class CClient extends ConfigBase { public class CClient extends ConfigBase {
public ConfigGroup client = group(0, "client", public ConfigGroup client = group(0, "client",
"Client-only settings - If you're looking for general settings, look inside your worlds serverconfig folder!"); Comments.client);
//no group //no group
public ConfigBool tooltips = b(true, "enableTooltips", "Show item descriptions on Shift and controls on Ctrl."); public ConfigBool tooltips = b(true, "enableTooltips",
public ConfigBool enableOverstressedTooltip = Comments.tooltips);
b(true, "enableOverstressedTooltip", "Display a tooltip when looking at overstressed components."); public ConfigBool enableOverstressedTooltip = b(true, "enableOverstressedTooltip",
public ConfigBool explainRenderErrors = Comments.enableOverstressedTooltip);
b(false, "explainRenderErrors", "Log a stack-trace when rendering issues happen within a moving contraption."); public ConfigBool explainRenderErrors = b(false, "explainRenderErrors",
public ConfigFloat fanParticleDensity = f(.5f, 0, 1, "fanParticleDensity"); Comments.explainRenderErrors);
public ConfigFloat filterItemRenderDistance = f(10f, 1, "filterItemRenderDistance", "[in Blocks]", "Maximum Distance to the player at which items in Blocks' filter slots will be displayed"); public ConfigFloat fanParticleDensity = f(.5f, 0, 1, "fanParticleDensity",
public ConfigBool rainbowDebug = Comments.fanParticleDensity);
b(true, "enableRainbowDebug", "Show colourful debug information while the F3-Menu is open."); public ConfigFloat filterItemRenderDistance = f(10f, 1, "filterItemRenderDistance", Comments.filterItemRenderDistance);
public ConfigBool experimentalRendering = public ConfigBool rainbowDebug = b(true, "enableRainbowDebug",
b(true, "experimentalRendering", "Use modern OpenGL features to drastically increase performance."); Comments.rainbowDebug);
public ConfigBool experimentalRendering = b(true, "experimentalRendering",
Comments.experimentalRendering);
public ConfigInt maxContraptionLightVolume = i(16384, 0, Integer.MAX_VALUE, "maximumContraptionLightVolume", public ConfigInt maxContraptionLightVolume = i(16384, 0, Integer.MAX_VALUE, "maximumContraptionLightVolume",
"The maximum amount of blocks for which to try and calculate dynamic contraption lighting. Decrease if large contraption cause too much lag");//no group Comments.maxContraptionLightVolume);
// no group
public ConfigInt mainMenuConfigButtonRow = i(2, 0, 4, "mainMenuConfigButtonRow", public ConfigInt mainMenuConfigButtonRow = i(2, 0, 4, "mainMenuConfigButtonRow",
"Choose the menu row that the Create config button appears on in the main menu", Comments.mainMenuConfigButtonRow);
"Set to 0 to disable the button altogether");
public ConfigInt mainMenuConfigButtonOffsetX = i(-4, Integer.MIN_VALUE, Integer.MAX_VALUE, "mainMenuConfigButtonOffsetX", public ConfigInt mainMenuConfigButtonOffsetX = i(-4, Integer.MIN_VALUE, Integer.MAX_VALUE, "mainMenuConfigButtonOffsetX",
"Offset the Create config button in the main menu by this many pixels on the X axis", Comments.mainMenuConfigButtonOffsetX);
"The sign (+/-) of this value determines what side of the row the button appears on (right/left)");
public ConfigInt ingameMenuConfigButtonRow = i(3, 0, 5, "ingameMenuConfigButtonRow", public ConfigInt ingameMenuConfigButtonRow = i(3, 0, 5, "ingameMenuConfigButtonRow",
"Choose the menu row that the Create config button appears on in the in-game menu", Comments.ingameMenuConfigButtonRow);
"Set to 0 to disable the button altogether");
public ConfigInt ingameMenuConfigButtonOffsetX = i(-4, Integer.MIN_VALUE, Integer.MAX_VALUE, "ingameMenuConfigButtonOffsetX", public ConfigInt ingameMenuConfigButtonOffsetX = i(-4, Integer.MIN_VALUE, Integer.MAX_VALUE, "ingameMenuConfigButtonOffsetX",
"Offset the Create config button in the in-game menu by this many pixels on the X axis", Comments.ingameMenuConfigButtonOffsetX);
"The sign (+/-) of this value determines what side of the row the button appears on (right/left)");
public ConfigBool ignoreFabulousWarning = b(false, "ignoreFabulousWarning", public ConfigBool ignoreFabulousWarning = b(false, "ignoreFabulousWarning",
"Setting this to true will prevent Create from sending you a warning when playing with Fabulous graphics enabled"); Comments.ignoreFabulousWarning);
//overlay group //overlay group
public ConfigGroup overlay = group(1, "goggleOverlay", "Settings for the Goggle Overlay"); public ConfigGroup overlay = group(1, "goggleOverlay",
Comments.overlay);
public ConfigInt overlayOffsetX = i(20, Integer.MIN_VALUE, Integer.MAX_VALUE, "overlayOffsetX", public ConfigInt overlayOffsetX = i(20, Integer.MIN_VALUE, Integer.MAX_VALUE, "overlayOffsetX",
"Offset the overlay from goggle- and hover- information by this many pixels on the X axis; Use /create overlay"); Comments.overlayOffset);
public ConfigInt overlayOffsetY = i(0, Integer.MIN_VALUE, Integer.MAX_VALUE, "overlayOffsetY", public ConfigInt overlayOffsetY = i(0, Integer.MIN_VALUE, Integer.MAX_VALUE, "overlayOffsetY",
"Offset the overlay from goggle- and hover- information by this many pixels on the Y axis; Use /create overlay"); Comments.overlayOffset);
public ConfigBool overlayCustomColor = b(false, "customColorsOverlay", "Enable this to use your custom colors for the Goggle- and Hover- Overlay"); public ConfigBool overlayCustomColor = b(false, "customColorsOverlay",
Comments.overlayCustomColor);
public ConfigInt overlayBackgroundColor = i(0xf0_100010, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBackgroundOverlay", public ConfigInt overlayBackgroundColor = i(0xf0_100010, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBackgroundOverlay",
"The custom background color to use for the Goggle- and Hover- Overlays, if enabled", "[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()); Comments.overlayBackgroundColor);
public ConfigInt overlayBorderColorTop = i(0x50_5000ff, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBorderTopOverlay", public ConfigInt overlayBorderColorTop = i(0x50_5000ff, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBorderTopOverlay",
"The custom top color of the border gradient to use for the Goggle- and Hover- Overlays, if enabled", "[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()); Comments.overlayBorderColorTop);
public ConfigInt overlayBorderColorBot = i(0x50_28007f, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBorderBotOverlay", public ConfigInt overlayBorderColorBot = i(0x50_28007f, Integer.MIN_VALUE, Integer.MAX_VALUE, "customBorderBotOverlay",
"The custom bot color of the border gradient to use for the Goggle- and Hover- Overlays, if enabled", "[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()); Comments.overlayBorderColorBot);
//placement assist group //placement assist group
public ConfigGroup placementAssist = group(1, "placementAssist", "Settings for the Placement Assist"); public ConfigGroup placementAssist = group(1, "placementAssist",
public ConfigEnum<PlacementIndicatorSetting> placementIndicator = e(PlacementIndicatorSetting.TEXTURE, Comments.placementAssist);
"indicatorType", public ConfigEnum<PlacementIndicatorSetting> placementIndicator = e(PlacementIndicatorSetting.TEXTURE, "indicatorType",
"What indicator should be used when showing where the assisted placement ends up relative to your crosshair", Comments.placementIndicator);
"Choose 'NONE' to disable the Indicator altogether"); public ConfigFloat indicatorScale = f(1.0f, 0f, "indicatorScale",
public ConfigFloat indicatorScale = Comments.indicatorScale);
f(1.0f, 0f, "indicatorScale", "Change the size of the Indicator by this multiplier");
//ponder group //ponder group
public ConfigGroup ponder = group(1, "ponder", "Ponder settings"); public ConfigGroup ponder = group(1, "ponder",
public ConfigBool comfyReading = Comments.ponder);
b(false, "comfyReading", "Slow down a ponder scene whenever there is text on screen."); public ConfigBool comfyReading = b(false, "comfyReading",
Comments.comfyReading);
//sound group //sound group
public ConfigGroup sound = group(1, "sound", "Sound settings"); public ConfigGroup sound = group(1, "sound",
public ConfigBool enableAmbientSounds = b(true, "enableAmbientSounds", "Make cogs rumble and machines clatter."); Comments.sound);
public ConfigFloat ambientVolumeCap = f(.1f, 0, 1, "ambientVolumeCap", "Maximum volume modifier of Ambient noise"); public ConfigBool enableAmbientSounds = b(true, "enableAmbientSounds",
Comments.enableAmbientSounds);
public ConfigFloat ambientVolumeCap = f(.1f, 0, 1, "ambientVolumeCap",
Comments.ambientVolumeCap);
@Override @Override
public String getName() { public String getName() {
@ -78,4 +81,62 @@ public class CClient extends ConfigBase {
public enum PlacementIndicatorSetting { public enum PlacementIndicatorSetting {
TEXTURE, TRIANGLE, NONE TEXTURE, TRIANGLE, NONE
} }
private static class Comments {
static String client = "Client-only settings - If you're looking for general settings, look inside your worlds serverconfig folder!";
static String tooltips = "Show item descriptions on Shift and controls on Ctrl.";
static String enableOverstressedTooltip = "Display a tooltip when looking at overstressed components.";
static String explainRenderErrors = "Log a stack-trace when rendering issues happen within a moving contraption.";
static String fanParticleDensity = "Higher density means more spawned particles.";
static String[] filterItemRenderDistance = new String[]{
"[in Blocks]",
"Maximum Distance to the player at which items in Blocks' filter slots will be displayed"
};
static String rainbowDebug = "Show colourful debug information while the F3-Menu is open.";
static String experimentalRendering = "Use modern OpenGL features to drastically increase performance.";
static String maxContraptionLightVolume = "The maximum amount of blocks for which to try and calculate dynamic contraption lighting. Decrease if large contraption cause too much lag";
static String[] mainMenuConfigButtonRow = new String[]{
"Choose the menu row that the Create config button appears on in the main menu",
"Set to 0 to disable the button altogether"
};
static String[] mainMenuConfigButtonOffsetX = new String[]{
"Offset the Create config button in the main menu by this many pixels on the X axis",
"The sign (-/+) of this value determines what side of the row the button appears on (left/right)"
};
static String[] ingameMenuConfigButtonRow = new String[]{
"Choose the menu row that the Create config button appears on in the in-game menu",
"Set to 0 to disable the button altogether"
};
static String[] ingameMenuConfigButtonOffsetX = new String[]{
"Offset the Create config button in the in-game menu by this many pixels on the X axis",
"The sign (-/+) of this value determines what side of the row the button appears on (left/right)"
};
static String ignoreFabulousWarning = "Setting this to true will prevent Create from sending you a warning when playing with Fabulous graphics enabled";
static String overlay = "Settings for the Goggle Overlay";
static String overlayOffset = "Offset the overlay from goggle- and hover- information by this many pixels on the respective axis; Use /create overlay";
static String overlayCustomColor = "Enable this to use your custom colors for the Goggle- and Hover- Overlay";
static String[] overlayBackgroundColor = new String[]{
"The custom background color to use for the Goggle- and Hover- Overlays, if enabled",
"[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()
};
static String[] overlayBorderColorTop = new String[]{
"The custom top color of the border gradient to use for the Goggle- and Hover- Overlays, if enabled",
"[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()
};
static String[] overlayBorderColorBot = new String[]{
"The custom bot color of the border gradient to use for the Goggle- and Hover- Overlays, if enabled",
"[in Hex: #AaRrGgBb]", ConfigAnnotations.IntDisplay.HEX.asComment()
};
static String placementAssist = "Settings for the Placement Assist";
static String[] placementIndicator = new String[]{
"What indicator should be used when showing where the assisted placement ends up relative to your crosshair",
"Choose 'NONE' to disable the Indicator altogether"
};
static String indicatorScale = "Change the size of the Indicator by this multiplier";
static String ponder = "Ponder settings";
static String comfyReading = "Slow down a ponder scene whenever there is text on screen.";
static String sound = "Sound settings";
static String enableAmbientSounds = "Make cogs rumble and machines clatter.";
static String ambientVolumeCap = "Maximum volume modifier of Ambient noise";
}
} }