Interface BookModule

All Superinterfaces:
ModuleSimple
public interface BookModule extends ModuleSimple
Formats the text a player writes into a book.

  • Method Details

    • config

      Message.Book config()
      Description copied from interface: ModuleSimple
      The config section this module reads its settings from.
      Specified by:
      config in interface ModuleSimple
      Returns:
      the settings

    • permission

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

    • legacyFormat

      Optional<String> legacyFormat(FPlayer fPlayer, String string)
      Formats a book on servers whose api carries plain strings rather than components.
      Parameters:
      fPlayer - the writer
      string - the raw text
      Returns:
      the formatted text, or empty if the module is off for this player

    • paperFormat

      Optional<String> paperFormat(FPlayer fPlayer, String string)
      Formats a book on servers whose api carries components rather than plain strings.
      Parameters:
      fPlayer - the writer
      string - the serialized component
      Returns:
      the formatted text, or empty if the module is off for this player