Package dev.demeng.pluginbase

Interface BaseSettings

public interface BaseSettings

Settings for the plugin base. Most of these methods should be overridden to suit your needs. Apply the settings using BasePlugin's #setBaseSettings().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BaseSettings.ColorScheme	A 3-color color scheme for messages or other text.

Method Summary

Modifier and Type	Method	Description
default BaseSettings.ColorScheme	colorScheme()	The color scheme of the plugin.
default String	dateFormat()	The format for dates.
default String	dateTimeFormat()	The format for dates and times combined.
default boolean	includePrefixOnEachLine()	Whether the prefix should be included on each line of chat messages.
default String	prefix()	The prefix for chat and console messages.

Method Details

prefix

default String prefix()

The prefix for chat and console messages. Not localized. Colorized internally.

Returns:

The prefix

includePrefixOnEachLine

default boolean includePrefixOnEachLine()

Whether the prefix should be included on each line of chat messages. If this is enabled, the plugin will split strings containing "\n" into individual lines, add the prefix to each line, and then return the string recombined with the "\n" delimiter.

Returns:

Whether the prefix should be included on each line

colorScheme

default BaseSettings.ColorScheme colorScheme()

The color scheme of the plugin.

Returns:

The color scheme

dateTimeFormat

default String dateTimeFormat()

The format for dates and times combined.

Returns:

The date and time format

dateFormat

default String dateFormat()

The format for dates.

Returns:

The date format