EpicKnarvik97/Stargate
EpicKnarvik97/Stargate
2
0
Fork 0
Code Issues 7 Pull Requests Projects 1 Releases 27 Wiki Activity

Gives all config options data types to make loading config values work properly

Browse Source
This commit is contained in:
Kristian Knarvik 2021-11-09 15:38:10 +01:00
parent 6466c7b0ff
commit 7c501cefe8
1 changed files with 69 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
src/main/java/net/knarcraft/stargate/config/ConfigOption.java
View File

@ -20,7 +20,7 @@ public enum ConfigOption {
/** /**
* The max number of portals on a single network * The max number of portals on a single network
*/ */
MAX_GATES_EACH_NETWORK("gates.maxGatesEachNetwork", "The max number of stargates in a single network", "0"), MAX_GATES_EACH_NETWORK("gates.maxGatesEachNetwork", "The max number of stargates in a single network", 0),
/** /**
* The network used if not specified * The network used if not specified
*/ */
@ -28,11 +28,11 @@ public enum ConfigOption {
/** /**
* Whether to remember the lastly used destination * Whether to remember the lastly used destination
*/ */
REMEMBER_DESTINATION("gates.cosmetic.rememberDestination", "Whether to remember the last destination used", "false"), REMEMBER_DESTINATION("gates.cosmetic.rememberDestination", "Whether to remember the last destination used", false),
/** /**
* Whether to sort the network destinations * Whether to sort the network destinations
*/ */
SORT_NETWORK_DESTINATIONS("gates.cosmetic.sortNetworkDestinations", "Whether to sort destinations by name", "false"), SORT_NETWORK_DESTINATIONS("gates.cosmetic.sortNetworkDestinations", "Whether to sort destinations by name", false),
/** /**
* The main color to use for all signs * The main color to use for all signs
*/ */
@ -44,57 +44,58 @@ public enum ConfigOption {
/** /**
* Whether to destroy portals when any blocks are broken by explosions * Whether to destroy portals when any blocks are broken by explosions
*/ */
DESTROYED_BY_EXPLOSION("gates.integrity.destroyedByExplosion", "Whether stargates should be destroyed by explosions", "false"), DESTROYED_BY_EXPLOSION("gates.integrity.destroyedByExplosion", "Whether stargates should be destroyed by explosions", false),
/** /**
* Whether to verify each portal's gate layout after each load * Whether to verify each portal's gate layout after each load
*/ */
VERIFY_PORTALS("gates.integrity.verifyPortals", "Whether to verify that portals match their gate layout on load", "false"), VERIFY_PORTALS("gates.integrity.verifyPortals", "Whether to verify that portals match their gate layout on load", false),
/** /**
* Whether to protect the entrance of portals * Whether to protect the entrance of portals
*/ */
PROTECT_ENTRANCE("gates.integrity.protectEntrance", "Whether to protect stargates' entrances", "false"), PROTECT_ENTRANCE("gates.integrity.protectEntrance", "Whether to protect stargates' entrances", false),
/** /**
* Whether to enable BungeeCord support * Whether to enable BungeeCord support
*/ */
ENABLE_BUNGEE("gates.functionality.enableBungee", "Whether to enable BungeeCord support", "false"), ENABLE_BUNGEE("gates.functionality.enableBungee", "Whether to enable BungeeCord support", false),
/** /**
* Whether to enable vehicle teleportation * Whether to enable vehicle teleportation
*/ */
HANDLE_VEHICLES("gates.functionality.handleVehicles", "Whether to enable vehicle teleportation", "true"), HANDLE_VEHICLES("gates.functionality.handleVehicles", "Whether to enable vehicle teleportation", true),
/** /**
* Whether to enable teleportation of empty vehicles * Whether to enable teleportation of empty vehicles
*/ */
HANDLE_EMPTY_VEHICLES("gates.functionality.handleEmptyVehicles", "Whether to enable teleportation of empty vehicles", "true"), HANDLE_EMPTY_VEHICLES("gates.functionality.handleEmptyVehicles", "Whether to enable teleportation of empty vehicles", true),
/** /**
* Whether to enable teleportation of creatures using vehicles * Whether to enable teleportation of creatures using vehicles
*/ */
HANDLE_CREATURE_TELEPORTATION("gates.functionality.handleCreatureTransportation", HANDLE_CREATURE_TRANSPORTATION("gates.functionality.handleCreatureTransportation",
"Whether to enable teleportation of vehicles containing non-player creatures", "true"), "Whether to enable teleportation of vehicles containing non-player creatures", true),
/** /**
* Whether to allow creatures to teleport alone, bypassing any access restrictions * Whether to allow creatures to teleport alone, bypassing any access restrictions
*/ */
HANDLE_NON_PLAYER_VEHICLES("gates.functionality.handleNonPlayerVehicles", HANDLE_NON_PLAYER_VEHICLES("gates.functionality.handleNonPlayerVehicles",
"Whether to enable teleportation of non-empty vehicles without a player", "true"), "Whether to enable teleportation of non-empty vehicles without a player", true),
/** /**
* Whether to enable teleportations of creatures on a leash * Whether to enable teleportations of creatures on a leash
*/ */
HANDLE_LEASHED_CREATURES("gates.functionality.handleLeashedCreatures", HANDLE_LEASHED_CREATURES("gates.functionality.handleLeashedCreatures",
"Whether to enable players to teleport a creature on a leash", "true"), "Whether to enable players to teleport a creature on a leash", true),
USE_ECONOMY("economy.useEconomy", "Whether to use economy to incur fees when stargates are used, created or destroyed", "false"), USE_ECONOMY("economy.useEconomy", "Whether to use economy to incur fees when stargates are used, created or destroyed", false),
CREATE_COST("economy.createCost", "The cost of creating a new stargate", "0"), CREATE_COST("economy.createCost", "The cost of creating a new stargate", 0),
DESTROY_COST("economy.destroyCost", "The cost of destroying a stargate. Negative to refund", "0"), DESTROY_COST("economy.destroyCost", "The cost of destroying a stargate. Negative to refund", 0),
USE_COST("economy.useCost", "The cost of using (teleporting through) a stargate", "0"), USE_COST("economy.useCost", "The cost of using (teleporting through) a stargate", 0),
TO_OWNER("economy.toOwner", "Whether any teleportation fees should go to the owner of the used stargate", "false"), TO_OWNER("economy.toOwner", "Whether any teleportation fees should go to the owner of the used stargate", false),
CHARGE_FREE_DESTINATION("economy.chargeFreeDestination", CHARGE_FREE_DESTINATION("economy.chargeFreeDestination",
"Whether to require payment if the destination is free, but the entrance stargate is not", "true"), "Whether to require payment if the destination is free, but the entrance stargate is not", true),
FREE_GATES_GREEN("economy.freeGatesGreen", "Whether to use green coloring to mark all free stargates", "false"), FREE_GATES_GREEN("economy.freeGatesGreen", "Whether to use green coloring to mark all free stargates", false),
DEBUG("debugging.debug", "Whether to enable debugging output", "false"), DEBUG("debugging.debug", "Whether to enable debugging output", false),
PERMISSION_DEBUG("debugging.permissionDebug", "Whether to enable permission debugging output", "false"); PERMISSION_DEBUG("debugging.permissionDebug", "Whether to enable permission debugging output", false);
private final String configNode; private final String configNode;
private final String description; private final String description;
private final String defaultValue; private final Object defaultValue;
private final OptionDataType dataType;
/** /**
* Instantiates a new config option * Instantiates a new config option
@ -103,10 +104,35 @@ public enum ConfigOption {
* @param description <p>The description of what this config option does</p> * @param description <p>The description of what this config option does</p>
* @param defaultValue <p>The default value of this config option</p> * @param defaultValue <p>The default value of this config option</p>
*/ */
ConfigOption(String configNode, String description, String defaultValue) { ConfigOption(String configNode, String description, Object defaultValue) {
this.configNode = configNode; this.configNode = configNode;
this.description = description; this.description = description;
this.defaultValue = defaultValue; this.defaultValue = defaultValue;
if (defaultValue instanceof String) {
this.dataType = OptionDataType.STRING;
} else if (defaultValue instanceof Boolean) {
this.dataType = OptionDataType.BOOLEAN;
} else if (defaultValue instanceof Integer) {
this.dataType = OptionDataType.INTEGER;
} else {
throw new IllegalArgumentException("Unknown config data type encountered.");
}
}
/**
* Gets a config option given its name
*
* @param name <p>The name of the config option to get</p>
* @return <p>The corresponding config option, or null if the name is invalid</p>
*/
public static ConfigOption getByName(String name) {
for (ConfigOption option : ConfigOption.values()) {
if (option.getName().equalsIgnoreCase(name)) {
return option;
}
}
return null;
} }
/** /**
@ -122,6 +148,24 @@ public enum ConfigOption {
return pathParts[pathParts.length - 1]; return pathParts[pathParts.length - 1];
} }
/**
* Gets the data type used for storing this config option
*
* @return <p>The data type used</p>
*/
public OptionDataType getDataType() {
return this.dataType;
}
/**
* Gets the config node of this config option
*
* @return <p>This config option's config node</p>
*/
public String getConfigNode() {
return this.configNode;
}
/** /**
* Gets the description of what this config option does * Gets the description of what this config option does
* *
@ -136,7 +180,7 @@ public enum ConfigOption {
* *
* @return <p>This config option's default value</p> * @return <p>This config option's default value</p>
*/ */
public String getDefaultValue() { public Object getDefaultValue() {
return this.defaultValue; return this.defaultValue;
} }