forestry.api.modules

Annotation Type ForestryModule

@Retention(value=RUNTIME)
public @interface ForestryModule

Annotation to provide additional information on IForestryModules. This information will be available via the "/forestry module info moduleID()" command ingame. Any class annotated by this and implementing IForestryModule will be loaded by the module manager of Forestry.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	containerID
java.lang.String	moduleID
java.lang.String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	author
boolean	coreModule
java.lang.String	help
java.lang.String	lootTable
java.lang.String	unlocalizedDescription
java.lang.String	url
java.lang.String	version

Element Detail

moduleID

public abstract java.lang.String moduleID

Returns:

Unique identifier for the module, no spaces!

containerID

public abstract java.lang.String containerID

Returns:

The unique identifier of the module container.

name

public abstract java.lang.String name

Returns:

Nice and readable module name.

author

public abstract java.lang.String author

Returns:

ForestryModule author's name.

Default:

""

url

public abstract java.lang.String url

Returns:

URL of plugin homepage.

Default:

""

help

public abstract java.lang.String help

Returns:

Not used (yet?).

Default:

""

lootTable

public abstract java.lang.String lootTable

Returns:

The name of the loot table file, if any.

Default:

""

coreModule

public abstract boolean coreModule

Returns:

True if this is a core module.

Default:

false

version

public abstract java.lang.String version

Returns:

Version of the module, if any.

Default:

""

unlocalizedDescription

public abstract java.lang.String unlocalizedDescription

Returns:

Localization key for a short description what the module does.

Default:

""