Update ConfigEntryAppearance to better document things

This commit is contained in:
coolGi
2023-06-07 14:07:51 +00:00
parent 3b4054c3c7
commit add6ee6f11
@@ -1,19 +1,24 @@
package com.seibel.lod.core.config.types.enums;
/**
* Allows options or categories to only be shown in the file or only in the ui
* (remember that if you make it only visible in the ui then the option wont save on game restart)
* Allows config entries (including options and categories) to only be shown in the file, or only in the ui
* (remember that if you make it only visible in the ui then the option won't save on game restart)
*
* @author coolGi
*/
public enum ConfigEntryAppearance {
/** Defeat option */
ALL(true, true),
/** Will only show the option in the UI. The option will be reverted on game restart */
ONLY_SHOW(true, false),
/** Only show the option in the file. There would be no way to access it using the UI */
ONLY_IN_FILE(true, false);
/** Sets whether the option should show in the UI */
public final boolean showInGui;
public final boolean showInFile; // If this is false then it wouldn't save the option
ConfigEntryAppearance(boolean showInGui, boolean showInFile) { // If both are false then the config won't touch the option
/** Sets whether to save an option, <br> If set to false, the option will be reset on game restart */
public final boolean showInFile;
ConfigEntryAppearance(boolean showInGui, boolean showInFile) { // If both are false then the config won't touch the option, but it would still be accessable if explicitly called
this.showInGui = showInGui;
this.showInFile = showInFile;
}