Interface ChatsettingModule

All Superinterfaces:
org.incendo.cloud.execution.CommandExecutionHandler<FPlayer>, ModuleCommand, ModuleLocalization, ModuleSimple
public interface ChatsettingModule extends ModuleCommand
The /chatsetting command, which opens the menu where a player toggles their personal chat options.

  • Method Details

    • config

      Command.Chatsetting config()
      Description copied from interface: ModuleCommand
      The config section for this command, which also holds its aliases.
      Specified by:
      config in interface ModuleCommand
      Specified by:
      config in interface ModuleSimple
      Returns:
      the command settings

    • permission

      Permission.Command.Chatsetting permission()
      Description copied from interface: ModuleSimple
      The permission that gates this module.
      Specified by:
      permission in interface ModuleSimple
      Returns:
      the permission

    • localization

      Localization.Command.Chatsetting localization(FPlayer fPlayer)
      Description copied from interface: ModuleLocalization
      The localization section for a player, picked from their chosen language.
      Specified by:
      localization in interface ModuleLocalization
      Parameters:
      fPlayer - the player the text is for
      Returns:
      the localization settings

    • saveSetting

      void saveSetting(FPlayer fPlayer, String messageType, boolean value)
      Stores an on/off setting.
      Parameters:
      fPlayer - the player
      messageType - which setting
      value - the new state

    • saveSetting

      void saveSetting(FPlayer fPlayer, SettingText settingText, String value)
      Stores a text setting, such as the chosen chat or locale.
      Parameters:
      fPlayer - the player
      settingText - which setting
      value - the new value

    • getMenuBuilder

      MenuBuilder getMenuBuilder()
      Returns the menu builder
      Returns:
      the menu builder

    • getPlayerChat

      String getPlayerChat(FPlayer fTarget)
      The chat a player currently writes to.
      Parameters:
      fTarget - the player
      Returns:
      the chat name

    • getCheckboxMaterial

      String getCheckboxMaterial(boolean enabled)
      The item used to draw a checkbox in the menu.
      Parameters:
      enabled - whether the option is on
      Returns:
      the item id

    • getCheckboxTitle

      String getCheckboxTitle(FPlayer fPlayer, String setting, boolean enabled)
      The title of one menu entry.
      Parameters:
      fPlayer - the reader
      setting - which setting
      enabled - whether the option is on
      Returns:
      the title

    • getCheckboxLore

      String getCheckboxLore(FPlayer fPlayer, boolean enabled)
      The hint shown under a menu entry.
      Parameters:
      fPlayer - the reader
      enabled - whether the option is on
      Returns:
      the hint