com.austinv11.collectiveframework.minecraft.config

Annotation Type Config

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Config

This annotation allows for a class to act as a config, simplifies config creation. Both static and declared fields represent config key-value pairs (unless excluded) Register an instance of the config with ConfigRegistry.registerConfig(Object) The config could be initialized at any three init stages-depending on when you register your config

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	doesSync Whether configs should be synced between server to client.
java.lang.String[]	exclude Used to get a list of fields that you want ignored
java.lang.String	fileName If preferred, the custom file name, otherwise it uses the class name
java.lang.String	handler Class for a custom config handler, it must implement IConfigurationHandler

Element Detail

fileName

public abstract java.lang.String fileName

If preferred, the custom file name, otherwise it uses the class name

Returns:

The file name (include the extension)

Default:

"@NULL@"

exclude

public abstract java.lang.String[] exclude

Used to get a list of fields that you want ignored

Returns:

The fields to ignore

Default:

{}

handler

public abstract java.lang.String handler

Class for a custom config handler, it must implement IConfigurationHandler

Returns:

The class name

Default:

"com.austinv11.collectiveframework.minecraft.config.ConfigRegistry$DefaultConfigurationHandler"

doesSync

public abstract boolean doesSync

Whether configs should be synced between server to client. Note: You could configure this by subscribing to the ConfigLoadEvent, cancelling ConfigLoadEvent.Pre will prevent syncing

Returns:

True to enable syncing

Default:

true