Class LanguageFile

java.lang.Object
me.tayebyassine.homestead.resources.ResourceFile
me.tayebyassine.homestead.resources.files.LanguageFile
public final class LanguageFile extends ResourceFile
Typed accessor for the active languages/<locale>.yml file.

  • Constructor Details

  • Method Details

    • getString

      public String getString(String path)
      Overrides:
      getString in class ResourceFile

    • getPrefix

      public String getPrefix()
      The chat prefix prepended to every plugin message.
      Returns:
      the prefix string

    • getDefaultRegionDescription

      public String getDefaultRegionDescription()
      The default region description used when creating a new region.
      Returns:
      the default region description

    • getDefaultWarDescription

      public String getDefaultWarDescription()
      The default war description used when a war is declared.
      Returns:
      the default war description

    • getDefaultBanReason

      public String getDefaultBanReason()
      The default ban reason shown when no reason is provided.
      Returns:
      the default ban reason

    • getWarDeclarationMessages

      public List<String> getWarDeclarationMessages(War.WagerType type)
      The list of messages broadcast when a war is declared.
      Returns:
      war declaration message lines, never null

    • getVariableStar

      public String getVariableStar()
      The star character used for level display.
      Returns:
      star character string

    • getVariableStarColor

      public String getVariableStarColor(int rate)
      The star colour for a specific rating level.
      Parameters:
      rate - the rating level (e.g. 1–5)
      Returns:
      the colour/formatting code

    • getVariableNone

      public String getVariableNone()
      The text shown when a value is not applicable.
      Returns:
      "N/A" style text

    • getVariableNa

      public String getVariableNa()
      The text shown when a value is not available.
      Returns:
      "N/A" style text

    • getVariablePermanent

      public String getVariablePermanent()
      The text shown for a permanent (non-expiring) duration.
      Returns:
      "Permanent" style text

    • getVariableNever

      public String getVariableNever()
      The text shown for a "never" timestamp.
      Returns:
      "Never" style text

    • getVariableIsTrue

      public String getVariableIsTrue()
      Boolean display text for true.
      Returns:
      "Yes" / "True" style text

    • getVariableIsFalse

      public String getVariableIsFalse()
      Boolean display text for false.
      Returns:
      "No" / "False" style text

    • getVariableIsEnabled

      public String getVariableIsEnabled()
      Enabled-state display text.
      Returns:
      "Enabled" style text

    • getVariableIsDisabled

      public String getVariableIsDisabled()
      Disabled-state display text.
      Returns:
      "Disabled" style text

    • getVariableFlagSet

      public String getVariableFlagSet()
      Text shown when a flag is set.
      Returns:
      flag-set text

    • getVariableFlagUnset

      public String getVariableFlagUnset()
      Text shown when a flag is unset.
      Returns:
      flag-unset text

    • getVariableBanned

      public String getVariableBanned()
      The text shown for a banned player status.
      Returns:
      "Banned" style text

    • getVariableOnline

      public String getVariableOnline()
      The text shown for an online player status.
      Returns:
      "Online" style text

    • getVariableOffline

      public String getVariableOffline()
      The text shown for an offline player status.
      Returns:
      "Offline" style text

    • getCommonVariable

      public String getCommonVariable(String name)
      A common variable by its key name.
      Parameters:
      name - the variable key under common.variables
      Returns:
      the variable text

    • getFormatterLocation

      public String getFormatterLocation()
      The format string for displaying a Location.
      Returns:
      location format pattern

    • getFormatterChunk

      public String getFormatterChunk()
      The format string for displaying a Chunk.
      Returns:
      chunk format pattern

    • getFormatterBalance

      public String getFormatterBalance()
      The format string for displaying a currency balance.
      Returns:
      balance format pattern

    • getFormatterDateFormat

      public String getFormatterDateFormat()
      The date / time pattern used by SimpleDateFormat.
      Returns:
      date format pattern

    • getFormatterDate

      public String getFormatterDate()
      The format string for displaying a timestamp with "ago" suffix.
      Returns:
      date-ago format pattern

    • getFormatterDuration

      public String getFormatterDuration()
      The format string for displaying a human-readable duration.
      Returns:
      duration format pattern

    • getFormatterGuiPaginationTitle

      public String getFormatterGuiPaginationTitle()
      The format string for GUI pagination titles.
      Returns:
      pagination title format

    • getFormatterPrivateChat

      public String getFormatterPrivateChat()
      The format string for private / party chat messages.
      Returns:
      private chat format pattern

    • getFormatterPlayerRegions

      public String getFormatterPlayerRegions()
      The format string for a list of player regions.
      Returns:
      player regions format

    • getFormatterPlayerRegionsJoining

      public String getFormatterPlayerRegionsJoining()
      The joining string between player region names.
      Returns:
      region list separator

    • getFormatterRegionMembers

      public String getFormatterRegionMembers()
      The format string for a list of region members.
      Returns:
      region members format

    • getFormatterRegionMembersJoining

      public String getFormatterRegionMembersJoining()
      The joining string between region member names.
      Returns:
      member list separator

    • getFormatterWarRegions

      public String getFormatterWarRegions()
      The format string for a list of war participant regions.
      Returns:
      war regions format

    • getFormatterWarRegionsJoining

      public String getFormatterWarRegionsJoining()
      The joining string between war region names.
      Returns:
      war region list separator

    • getFormatterAgoDays

      public String getFormatterAgoDays()
      The "ago" label for days.
      Returns:
      days-ago label

    • getFormatterAgoHours

      public String getFormatterAgoHours()
      The "ago" label for hours.
      Returns:
      hours-ago label

    • getFormatterAgoMinutes

      public String getFormatterAgoMinutes()
      The "ago" label for minutes.
      Returns:
      minutes-ago label

    • getFormatterAgoSeconds

      public String getFormatterAgoSeconds()
      The "ago" label for seconds.
      Returns:
      seconds-ago label

    • getHelpCommandDescriptionKeys

      public List<String> getHelpCommandDescriptionKeys()
      All keys registered under the help command descriptions section.
      Returns:
      list of command keys

    • getHelpCommandDescription

      public String getHelpCommandDescription(String key)
      The description text for a specific help command.
      Parameters:
      key - the command key
      Returns:
      the description text

    • getHelpEntryFormat

      public String getHelpEntryFormat()
      The format for a single help page entry.
      Returns:
      entry format string

    • getHelpPrevHover

      public String getHelpPrevHover()
      The hover text for the "previous page" button.
      Returns:
      previous-page hover text

    • getHelpPrev

      public String getHelpPrev()
      The label for the "previous page" button.
      Returns:
      previous-page label

    • getHelpPrevDisabled

      public String getHelpPrevDisabled()
      The label for a disabled "previous page" button.
      Returns:
      disabled previous-page label

    • getHelpNextHover

      public String getHelpNextHover()
      The hover text for the "next page" button.
      Returns:
      next-page hover text

    • getHelpNext

      public String getHelpNext()
      The label for the "next page" button.
      Returns:
      next-page label

    • getHelpNextDisabled

      public String getHelpNextDisabled()
      The label for a disabled "next page" button.
      Returns:
      disabled next-page label

    • getHelpFooter

      public String getHelpFooter()
      The footer text shown at the bottom of every help page.
      Returns:
      help footer text

    • getInputPromptTitle

      public List<String> getInputPromptTitle(String promptId)
      The title lines shown for a specific input prompt.
      Parameters:
      promptId - the prompt identifier
      Returns:
      title lines, never null

    • getInputPromptChat

      public String getInputPromptChat(String promptId)
      The chat message for a specific input prompt.
      Parameters:
      promptId - the prompt identifier
      Returns:
      chat prompt text

    • getInputPromptActionbar

      public String getInputPromptActionbar(String promptId)
      The action-bar message for a specific input prompt.
      Parameters:
      promptId - the prompt identifier
      Returns:
      action-bar text

    • getLogMessage

      public String getLogMessage(String logId)
      The log message template for a specific log type.
      Parameters:
      logId - the log identifier
      Returns:
      the log message template

    • getVariableLogAuthor

      public String getVariableLogAuthor()
      The variable placeholder text for the log author.
      Returns:
      log-author variable text

    • getVariableRentVacateNotice

      public String getVariableRentVacateNotice()
      The variable text for the rent vacate notice period.
      Returns:
      rent-vacate-notice variable text