com.djrapitops.plan.extension.annotation

Annotation Type PluginInfo

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

Class Annotation for informing Plan about a plugin.

See Also:

to determine preferred tab ordering if you use {@link Tab}s.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Name of the plugin, limited to 50 characters.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Color	color Color preference of the plugin.
Family	iconFamily Family of Font Awesome icon.
java.lang.String	iconName Name of Font Awesome icon.

Element Detail

name

public abstract java.lang.String name

Name of the plugin, limited to 50 characters.

Returns:

String of max 50 characters, remainder will be clipped.

iconName

public abstract java.lang.String iconName

Name of Font Awesome icon.

See https://fontawesome.com/icons (select 'free')) for icons and their Family.

Returns:

Name of the icon, if name is not valid no icon is shown.

Default:

"cube"

iconFamily

public abstract Family iconFamily

Family of Font Awesome icon.

See https://fontawesome.com/icons (select 'free')) for icons and their Family.

Returns:

Family that matches an icon, if there is no icon for this family no icon is shown.

Default:

com.djrapitops.plan.extension.icon.Family.SOLID

color

public abstract Color color

Color preference of the plugin.

This color will be set as the default color to use for plugin's elements.

Returns:

Preferred color. If none are specified defaults are used.

Default:

com.djrapitops.plan.extension.icon.Color.NONE