com.sucy.skill.api.Settings Maven / Gradle / Ivy
Show all versions of proskillapi Show documentation
/**
* SkillAPI
* com.sucy.skill.api.Settings
*
* The MIT License (MIT)
*
* Copyright (c) 2014 Steven Sucy
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software") to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.sucy.skill.api;
import com.google.common.collect.ImmutableList;
import com.sucy.skill.log.Logger;
import mc.promcteam.engine.mccore.config.parse.DataSection;
import mc.promcteam.engine.mccore.config.parse.NumberParser;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
/**
*
Represents a set of settings that store configurable data for an object.
*/
public class Settings {
private static final String BASE = "-base";
private static final String SCALE = "-scale";
private final HashMap settings;
public Settings() {
this.settings = new LinkedHashMap<>();
}
public Settings(final Settings settings) {
this.settings = new HashMap<>(settings.settings);
}
/**
* Sets the value for a setting. You should only provide a
* String, int, boolean, or double as those are the only
* supported types.
*
* @param key setting key
* @param value setting value
*/
public void set(String key, Object value) {
settings.put(key, value);
}
/**
* Defines a new scaling setting
* Values are overwritten after the configuration
* is loaded. Using this method is simply to define
* the default values before configuration changes.
* You should not use this method after the initial setup.
*
* @param key attribute name
* @param base base value
* @param scale value scale
*/
public void set(String key, double base, double scale) {
settings.put(key + BASE, base);
settings.put(key + SCALE, scale);
}
/**
* Sets the base value of a scaling setting
* If the scaling setting is not set, this will default
* the scale of the setting to 0.
* This is used to override the default values.
* You should not use this method. When defining scaling settings,
* use set(String, double, double)
*
* @param key scaling setting name
* @param value new base value
*/
public void setBase(String key, double value) {
if (!settings.containsKey(key + SCALE)) {
settings.put(key + SCALE, 0.0);
}
settings.put(key + BASE, value);
}
/**
* Sets the bonus value of a scaling setting
* If the scaling setting is not set, this will default
* the base of the setting to 0.
* This is used by the API to override the default values.
* You should not use this method. When defining scaling settings,
* use set(String, double, double)
*
* @param key scaling setting name
* @param value new scale value
*/
public void setScale(String key, double value) {
if (!settings.containsKey(key + BASE)) {
settings.put(key + BASE, 0.0);
}
settings.put(key + SCALE, value);
}
/**
* Retrieves a double value from the settings. If the setting is
* not set, this will instead return 0.
*
* @param key setting key
* @return double setting value
*/
public double getDouble(String key) {
return getDouble(key, 0);
}
/**
* Retrieves a double value from the settings. If the setting is
* not set, this will instead return 0.
*
* @param key setting key
* @param defaultValue the default value in case not set
* @return double setting value
*/
public double getDouble(String key, double defaultValue) {
if (settings.containsKey(key)) {
return NumberParser.parseDouble(settings.get(key).toString());
} else {
set(key, defaultValue);
return defaultValue;
}
}
/**
* Retrieves an integer value from the settings. If the setting is
* not set, this will instead return 0.
*
* @param key setting key
* @return integer setting value
*/
public int getInt(String key) {
return getInt(key, 0);
}
/**
* Retrieves an integer value from the settings. If the setting is
* not set, this will instead return the default value.
*
* @param key setting key
* @param defaultValue the default value in case not set
* @return integer setting value
*/
public int getInt(String key, int defaultValue) {
if (settings.containsKey(key)) {
return Integer.parseInt(settings.get(key).toString());
} else {
set(key, defaultValue);
return defaultValue;
}
}
/**
* Retrieves a boolean value from the settings. If the setting is
* not set, this will instead return false.
*
* @param key setting key
* @return boolean setting value
*/
public boolean getBool(String key) {
return settings.containsKey(key) && Boolean.parseBoolean(settings.get(key).toString());
}
/**
* Retrieves a boolean value from the settings. If the setting is
* not set, this will instead return false.
*
* @param key setting key
* @param defaultValue the default value in case not set
* @return boolean setting value
*/
public boolean getBool(String key, boolean defaultValue) {
if (settings.containsKey(key)) {
return Boolean.parseBoolean(settings.get(key).toString());
} else {
set(key, defaultValue);
return defaultValue;
}
}
/**
* Retrieves a string value from the settings. If the setting is
* not set, this will instead return null.
*
* @param key setting key
* @return String setting value
*/
public String getString(String key) {
return getString(key, null);
}
/**
* Retrieves a string value from the settings. If the setting is
* not set, this will instead return the default value.
*
* @param key setting key
* @param defaultValue the default value in case not set
* @return String setting value
*/
public String getString(String key, String defaultValue) {
if (settings.containsKey(key) && settings.get(key) != null) {
return settings.get(key).toString();
} else {
set(key, defaultValue);
return defaultValue;
}
}
/**
* Retrieves a string list from the settings
*
* @param key settings key
* @return string list or empty list if not found
*/
@SuppressWarnings("unchecked")
public List getStringList(String key) {
if (settings.containsKey(key)) {
final Object value = settings.get(key);
if (value instanceof List) {
return (List) settings.get(key);
} else if (value.toString().equals("[]")) {
return new ArrayList<>();
} else {
return ImmutableList.of(value.toString());
}
} else {
return new ArrayList<>();
}
}
/**
* Calculates a value for a scaling setting at a given level.
* If the scaling setting does not exist, this will instead return 0.
*
* @param key scaling setting name
* @param level level of scaling
* @return scaled setting value
*/
public double getAttr(String key, int level) {
return getAttr(key, level, 0);
}
/**
* Calculates a value for a scaling setting at a given level.
* If the scaling setting does not exist, this will instead return
* the provided default value.
*
* @param key scaling setting name
* @param level level of scaling
* @param defaultValue the default value in case not set
* @return scaled setting value
*/
public double getAttr(String key, int level, double defaultValue) {
if (!has(key)) {
set(key, defaultValue, 0);
return defaultValue;
}
return getBase(key) + getScale(key) * (level - 1);
}
/**
* Gets the base value of an attribute
* If the attribute is not set, this will return 0.
*
* @param key attribute name
* @return base value
*/
public double getBase(String key) {
if (!settings.containsKey(key + BASE)) {
return 0;
} else {
return NumberParser.parseDouble(settings.get(key + BASE).toString());
}
}
/**
* Gets the scale value of an attribute
* If the attribute is not set, this will return 0.
*
* @param key attribute name
* @return change in value per level
*/
public double getScale(String key) {
if (!settings.containsKey(key + SCALE)) {
return 0;
} else {
return NumberParser.parseDouble(settings.get(key + SCALE).toString());
}
}
/**
* Retrieves a generic attribute.
* If the attribute is not set, this will return 0 instead.
*
* @param key attribute name
* @param level level of scaling
* @return attribute value or 0 if not found
*/
public Object getObj(String key, int level) {
if (settings.containsKey(key)) {
return settings.get(key);
} else if (settings.containsKey(key + BASE)) {
return getAttr(key, level);
} else {
return 0;
}
}
/**
* Checks whether the setting is defined.
* A setting is defined when it is set at any point using
* any of the setter methods or while loading from the configuration.
*
* @param key name of the setting
* @return true if defined, false otherwise
*/
public boolean has(String key) {
return settings.containsKey(key) || settings.containsKey(key + BASE);
}
/**
* Removes a setting.
* If the setting is not set, this will not do anything.
*
* @param key name of the attribute
*/
public void remove(String key) {
settings.remove(key);
settings.remove(key + BASE);
settings.remove(key + SCALE);
}
/**
* Checks to make sure the settings have a required scaling value.
* If the scaling setting is not set, the scaling setting will be created with
* the provided values.
* If the attribute already exists, this will do nothing.
*
* @param key key of the setting to check
* @param defaultBase default base value
* @param defaultScale default scale value
*/
public void checkDefault(String key, double defaultBase, double defaultScale) {
if (!has(key)) {
set(key, defaultBase, defaultScale);
}
}
/**
* Saves settings to a configuration section.
* If the config section is null, this does not do anything.
*
* @param config configuration section to save to
*/
public void save(DataSection config) {
if (config == null) {
return;
}
for (String key : settings.keySet()) {
config.set(key, settings.get(key));
}
}
/**
* Loads attributes from a configuration section
* If the section is null or has no keys, this will not do
* anything.
* Keys that do not point to valid sections for the base/scale
* values will not be loaded.
* Sections without a base or without a scale value will load
* what's present and default the missing one to 0.
*
* @param config configuration section to load from
*/
public void load(DataSection config) {
if (config == null) {
return;
}
for (String key : config.keys()) {
settings.put(key, config.get(key));
}
}
/**
* Dumps the settings to the console for debugging purposes
*/
public void dumpToConsole() {
Logger.log("Settings:");
for (String key : settings.keySet()) {
Logger.log("- " + key + ": " + settings.get(key).toString());
}
}
}