com.austinv11.collectiveframework.minecraft.config

Annotation Type Description

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Description

Describes a config field

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	comment A short comment explaining what the config value does

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	category The category the config value is under
boolean	clientSideOnly Determines whether a config option only effects the client

Element Detail

comment

public abstract java.lang.String comment

A short comment explaining what the config value does

Returns:

The comment

category

public abstract java.lang.String category

The category the config value is under

Returns:

The category (capitalization matters!)

Default:

"General"

clientSideOnly

public abstract boolean clientSideOnly

Determines whether a config option only effects the client

Returns:

True for the option to be client side only

Default:

false