Class BundleConfigSpec

java.lang.Object

de.luckymcdev.foundryengine.common.bundle.config.BundleConfigSpec

public class BundleConfigSpec
extends Object

Builder used inside BundleEntrypoint.onLoad() to declare typed config entries for a bundle.

Example usage in a Groovy entrypoint:

class MyEntrypoint extends BundleEntrypoint {
    ConfigValue<Boolean> enableFeature
    ConfigValue<Integer> maxCount

    void onLoad() {
        def spec = new BundleConfigSpec(bundleConfig)
        enableFeature = spec.defineBoolean("enable_feature", true, "Whether the feature is enabled")
        maxCount      = spec.defineInt("max_count", 10, "Maximum number of things")
        spec.build()

        if (enableFeature.get()) { ... }
    }
}

Constructor Summary

Constructors

Constructor	Description
BundleConfigSpec(BundleConfig config)

Method Summary

Modifier and Type	Method	Description
void	build()	Finalizes the spec and triggers a load from disk.
ConfigValue<Boolean>	defineBoolean(String key, boolean defaultValue)
ConfigValue<Boolean>	defineBoolean(String key, boolean defaultValue, String comment)	Defines a boolean config value.
ConfigValue<Double>	defineDouble(String key, double defaultValue)
ConfigValue<Double>	defineDouble(String key, double defaultValue, String comment)	Defines a double config value.
ConfigValue<Integer>	defineInt(String key, int defaultValue)
ConfigValue<Integer>	defineInt(String key, int defaultValue, String comment)	Defines an integer config value.
ConfigValue<String>	defineString(String key, String defaultValue)
ConfigValue<String>	defineString(String key, String defaultValue, String comment)	Defines a string config value.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BundleConfigSpec

public BundleConfigSpec(BundleConfig config)

Method Details

defineBoolean

public ConfigValue<Boolean> defineBoolean(String key,
 boolean defaultValue,
 String comment)

Defines a boolean config value.

defineBoolean

public ConfigValue<Boolean> defineBoolean(String key,
 boolean defaultValue)

defineInt

public ConfigValue<Integer> defineInt(String key,
 int defaultValue,
 String comment)

Defines an integer config value.

defineInt

public ConfigValue<Integer> defineInt(String key,
 int defaultValue)

defineDouble

public ConfigValue<Double> defineDouble(String key,
 double defaultValue,
 String comment)

Defines a double config value.

defineDouble

public ConfigValue<Double> defineDouble(String key,
 double defaultValue)

defineString

public ConfigValue<String> defineString(String key,
 String defaultValue,
 String comment)

Defines a string config value.

defineString

public ConfigValue<String> defineString(String key,
 String defaultValue)

build

public void build()

Finalizes the spec and triggers a load from disk. Must be called after all values are defined.