com.elmakers.mine.bukkit.api.magic

Interface Messages

public interface Messages

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key)
String	describeCurrency(double amount)
String	describeItem(org.bukkit.inventory.ItemStack item)
String	escape(String source)
String	formatLevelString(String message, float amount)
String	formatLevelString(String message, float amount, float max)
String	formatList(String basePath, Collection<String> nodes, String nameKey)
String	formatPropertyString(String template, float amount, float max, String propertyTemplate) Similar to getPropertyString, but this one doesn't do the message lookup for you.
String	get(String key)
String	get(String key, String defaultValue)
List<String>	getAll(String path)
Collection<String>	getAllKeys()
String	getCurrency()
String	getCurrencyPlural()
String	getIfSet(String key)
String	getLevelString(String templateName, float amount)
String	getLevelString(String templateName, float amount, float max)
String	getParameterized(String key, String paramName, String paramValue)
String	getParameterized(String key, String paramName1, String paramValue1, String paramName2, String paramValue2)
String	getPercentageString(String templateName, float amount)
String	getPropertyString(String templateName, float amount, float max, String propertyTemplateName) Get a level string that applies a separate template to the value, filling the value into the $property variable.
String	getRandomized(String key)
String	getRangeDescription(double range, String messagesKey)
String	getSpace(int pixels) This relies on the negative space font RP: https://github.com/AmberWat/NegativeSpaceFont And specific mappings defined in messages, in the gui.space section
String	getTimeDescription(long time)
String	getTimeDescription(long time, String descriptionType)
String	getTimeDescription(long time, String descriptionType, String messagesPath)

Method Detail

containsKey

boolean containsKey(String key)

get

@Nonnull
String get(String key)

get

@Nonnull
String get(String key,
                    String defaultValue)

getIfSet

@Nullable
String getIfSet(String key)

getRandomized

@Nullable
String getRandomized(String key)

getAll

@Nullable
List<String> getAll(String path)

getParameterized

String getParameterized(String key,
                        String paramName,
                        String paramValue)

getParameterized

String getParameterized(String key,
                        String paramName1,
                        String paramValue1,
                        String paramName2,
                        String paramValue2)

escape

String escape(String source)

describeItem

@Nonnull
String describeItem(org.bukkit.inventory.ItemStack item)

describeCurrency

String describeCurrency(double amount)

getCurrency

String getCurrency()

getCurrencyPlural

String getCurrencyPlural()

formatList

String formatList(String basePath,
                  Collection<String> nodes,
                  String nameKey)

getLevelString

String getLevelString(String templateName,
                      float amount)

getLevelString

String getLevelString(String templateName,
                      float amount,
                      float max)

getPercentageString

String getPercentageString(String templateName,
                           float amount)

getPropertyString

String getPropertyString(String templateName,
                         float amount,
                         float max,
                         String propertyTemplateName)

Get a level string that applies a separate template to the value, filling the value into the $property variable. The escaped property template is then applied to the level string via the normal $roman,$value,$percentage,$amount variables.

Parameters:

templateName - The key of the string template, such as "protection.fall", which would have an entry such as "Protection $roman"

amount - The amount of the property to print

max - The max value of the property to print, used in "roman" mode

propertyTemplateName - the template to use for formatting the amount, such as "properties.stacked_negative, which would have an entry such as "+$property". This is most often used to differentiate between positive and negative values.

Returns:

The formatted string

formatLevelString

String formatLevelString(String message,
                         float amount)

formatLevelString

String formatLevelString(String message,
                         float amount,
                         float max)

formatPropertyString

String formatPropertyString(String template,
                            float amount,
                            float max,
                            String propertyTemplate)

Similar to getPropertyString, but this one doesn't do the message lookup for you. You pass in messages directly to be escaped.

Parameters:

template - The string to escape, such as "Protection $roman"

amount - The amount of the property to print

max - The max value of the property to print, used in "roman" mode

propertyTemplate - The string to use for property formatting, such as "+&4$property"

Returns:

The formatted string

getTimeDescription

@Nonnull
String getTimeDescription(long time)

getTimeDescription

@Nonnull
String getTimeDescription(long time,
                                   @Nonnull
                                   String descriptionType)

getTimeDescription

@Nonnull
String getTimeDescription(long time,
                                   @Nonnull
                                   String descriptionType,
                                   @Nullable
                                   String messagesPath)

getRangeDescription

@Nonnull
String getRangeDescription(double range,
                                    @Nonnull
                                    String messagesKey)

getAllKeys

@Nonnull
Collection<String> getAllKeys()

getSpace

@Nonnull
String getSpace(int pixels)

This relies on the negative space font RP: https://github.com/AmberWat/NegativeSpaceFont And specific mappings defined in messages, in the gui.space section