dev.aurelium.auraskills.api.message.MessageManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of auraskills-api Show documentation

API for AuraSkills, the ultra-versatile RPG skills plugin for Minecraft

There is a newer version: 2.2.3

package dev.aurelium.auraskills.api.message;

import dev.aurelium.auraskills.api.skill.Skill;
import dev.aurelium.auraskills.api.stat.Stat;

import java.util.Locale;

public interface MessageManager {

    /**
     * Gets a messaged defined in an AuraSkills messages file for a given path and locale.
     *
     * @param path the path to the message, with periods separating sections
     * @param locale the locale/language to get the message in
     * @return The message in the given locale, or the default language if missing. If no languages contain
     * the specified path, the path will be returned back unchanged.
     */
    String getMessage(String path, Locale locale);

    /**
     * Gets the user-configured display name for a skill in a given language.
     *
     * @param skill the skill whose name to get
     * @param locale the language, will use default if not found
     * @return the skill display name
     */
    String getSkillDisplayName(Skill skill, Locale locale);

    /**
     * Gets the user-configured description as shown in in-game
     * menus for a skill in a given language.
     *
     * @param skill the skill whose description to get
     * @param locale the language, will use default if not found
     * @return the skill description
     */
    String getSkillDescription(Skill skill, Locale locale);

    /**
     * Gets the user-configured display name for a stat in a given language.
     *
     * @param stat the stat whose name to get
     * @param locale the language, will use default if not found
     * @return the stat display name
     */
    String getStatDisplayName(Stat stat, Locale locale);

    /**
     * Gets the user-configured description as shown in in-game menus
     * for a stat in a given language.
     *
     * @param stat the stat whose description to get
     * @param locale the language, will use default if not found
     * @return the stat display name
     */
    String getStatDescription(Stat stat, Locale locale);

    /**
     * Gets the default language of the plugin as specified by the config,
     * which is {@link Locale#ENGLISH} if unchanged.
     *
     * @return the default language
     */
    Locale getDefaultLanguage();

    /**
     * Utility method to convert a word to its plural form, following English
     * grammar rules.
     *
     * @param word the world to convert
     * @return the plural form
     */
    String toPluralForm(String word);

}