Package org.sgrewritten.stargate.api.formatting

Enum Class TranslatableMessage

java.lang.Object
java.lang.Enum<TranslatableMessage>
org.sgrewritten.stargate.api.formatting.TranslatableMessage
All Implemented Interfaces:
Serializable, Comparable<TranslatableMessage>, Constable
public enum TranslatableMessage extends Enum<TranslatableMessage>
Keeps track of all translatable messages
Author:
Thorin, Pheotis

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADDON_INTERFERE
    A generic message to display when an addon prevents the user from doing something
    BUNGEE_DENY
    The message to display when a player is lacking permissions to create a bungee or inter-server network
    BUNGEE_DISABLED
    The message to display when a player tries to interact / create / enter a bungee or inter-server gate.
    BUNGEE_INVALID_GATE
    The message to display if a BungeeCord exit gate is invalid
    BUNGEE_INVALID_NETWORK
    The message to display if a BungeeCord exit network is invalid
    BUNGEE_LACKING_SIGN_INFORMATION
    The message to display if creating a legacy BungeeCord portal and the sign is missing information
    BUNGEE_SIGN_LINE_4
    The last line on a sign for legacy bungee portals
    COMMAND_HELP
    The message to display whenever the admin-help is executed
    COMMAND_INFO
    The message to display whenever the admin-info is executed
    COMMAND_RELOAD
    The message to display whenever the reload command is executed
    CREATE
    The message to be displayed when a stargate has been successfully created
    CREATE_PERSONAL
    The message to be display when a portal has successfully been created on a personal network
    CUSTOM_NETWORK
    The name of a custom network
    DEFAULT_NETWORK
    The name of the default network
    DENY
    The message to be displayed when a player is missing the required permissions to teleport to a destination
    DESTINATION_EMPTY
    The message to display when a networked portal does not have any destinations
    DESTROY
    The message to display when a stargate has been destroyed
    DISCONNECTED
    The sign text to use for marking a stargate as disconnected
    ECO_DEDUCT
    The message to be displayed when a player successfully is charged money
    ECO_OBTAIN
    The message to be displayed when a player receives money from an owned portal
    FANCY_INTERSERVER
    The name of a cross server network
    GATE
    The name of a portal
    GATE_ALREADY_EXIST
    The message to display when a new stargate's name is already in use
    GATE_CONFLICT
    The message to display if a new stargate conflicts with an existing one
    GATE_CREATE_FALLBACK
    The message to display during portal creation if the chosen network changed
    GATE_DENY
    The message to display when a player is lacking permission to create a gateDesign
    GATE_OWNED_BY
    The second line of a portals sign when displaying portal info
    INTER_SERVER_DISABLED
    The message to display when a Fancy Inter-server type portal is created, but server is on a local database
    INVALID
    The message to display if a stargate doesn't have a valid destination
    INVALID_NAME
    The message to display when the NetworkType is not compatible with given name
    INVALID_NAME_LENGTH
    The message to display when a portal or network name exceeds the max length
    LACKING_FLAGS_PERMISSION
    The message to display
    LACKING_FUNDS
    The message to be displayed if a player is missing the sufficient funds to perform an action
    NET_CONFLICT
    The message to display when a network is in conflict with a network of another type
    NET_DENY
    The message to display when a player is lacking the permission to access a network
    NET_FULL
    The message to display when a network is already full
    NETWORK
    The name of a local network
    OUTSIDE_WORLD_BORDER
    The message to send if the player is teleporting past the world-border
    PARITY_UPGRADE
    The message to send when installing parity modules
    PERSONAL_NETWORK
    The name of a personal network
    PREFIX
    The [Stargate] prefix used at the start of all messages
    RANDOM
    The sign text to use for marking a stargate as random
    RIGHT_CLICK
    The first line of the right-click prompt to display on signs
    SPAWN_CHUNKS_CONFLICTING
    The message to display if a stargate is created within the spawn area
    TELEPORT
    The message to display when a player is being teleported
    TELEPORTATION_OCCUPIED
    The message to be displayed when gate is used by another player
    TERMINAL_NETWORK
    The name of a terminal network
    TO_USE
    The second line of the right-click prompt to display on signs
    UNIMPLEMENTED_CONFLICT
    The message to send when there is an inter-server conflict
    UNIMPLEMENTED_FLAG
    The message to send when a flag is not implemented yet
    UNIMPLEMENTED_INTER_SERVER
    The message to send whenever an inter-server portal is created
    WORLD_DENY
    The message to display when a player does not have access to a world

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessageKey()
    Gets this translatable message's string key used to identify the message in language files
    static TranslatableMessage
    parse(String key)
    Parses the given string key into its enum representation
    static TranslatableMessage
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TranslatableMessage[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PREFIX

      public static final TranslatableMessage PREFIX
      The [Stargate] prefix used at the start of all messages

    • TELEPORT

      public static final TranslatableMessage TELEPORT
      The message to display when a player is being teleported

    • DESTROY

      public static final TranslatableMessage DESTROY
      The message to display when a stargate has been destroyed

    • DESTINATION_EMPTY

      public static final TranslatableMessage DESTINATION_EMPTY
      The message to display when a networked portal does not have any destinations

    • INVALID

      public static final TranslatableMessage INVALID
      The message to display if a stargate doesn't have a valid destination

      This is triggered when a stargate's button is clicked and it's missing a valid destination. It's also triggered when trying to teleport if the destination is missing.

    • DENY

      public static final TranslatableMessage DENY
      The message to be displayed when a player is missing the required permissions to teleport to a destination

    • TELEPORTATION_OCCUPIED

      public static final TranslatableMessage TELEPORTATION_OCCUPIED
      The message to be displayed when gate is used by another player

    • LACKING_FUNDS

      public static final TranslatableMessage LACKING_FUNDS
      The message to be displayed if a player is missing the sufficient funds to perform an action

    • ECO_DEDUCT

      public static final TranslatableMessage ECO_DEDUCT
      The message to be displayed when a player successfully is charged money

    • ECO_OBTAIN

      public static final TranslatableMessage ECO_OBTAIN
      The message to be displayed when a player receives money from an owned portal

    • CREATE

      public static final TranslatableMessage CREATE
      The message to be displayed when a stargate has been successfully created

    • CREATE_PERSONAL

      public static final TranslatableMessage CREATE_PERSONAL
      The message to be display when a portal has successfully been created on a personal network

    • NET_DENY

      public static final TranslatableMessage NET_DENY
      The message to display when a player is lacking the permission to access a network

    • NET_CONFLICT

      public static final TranslatableMessage NET_CONFLICT
      The message to display when a network is in conflict with a network of another type

    • GATE_DENY

      public static final TranslatableMessage GATE_DENY
      The message to display when a player is lacking permission to create a gateDesign

    • WORLD_DENY

      public static final TranslatableMessage WORLD_DENY
      The message to display when a player does not have access to a world

    • INVALID_NAME_LENGTH

      public static final TranslatableMessage INVALID_NAME_LENGTH
      The message to display when a portal or network name exceeds the max length

    • INVALID_NAME

      public static final TranslatableMessage INVALID_NAME
      The message to display when the NetworkType is not compatible with given name

    • ADDON_INTERFERE

      public static final TranslatableMessage ADDON_INTERFERE
      A generic message to display when an addon prevents the user from doing something

    • GATE_ALREADY_EXIST

      public static final TranslatableMessage GATE_ALREADY_EXIST
      The message to display when a new stargate's name is already in use

    • NET_FULL

      public static final TranslatableMessage NET_FULL
      The message to display when a network is already full

    • GATE_CONFLICT

      public static final TranslatableMessage GATE_CONFLICT
      The message to display if a new stargate conflicts with an existing one

    • RIGHT_CLICK

      public static final TranslatableMessage RIGHT_CLICK
      The first line of the right-click prompt to display on signs

    • TO_USE

      public static final TranslatableMessage TO_USE
      The second line of the right-click prompt to display on signs

    • RANDOM

      public static final TranslatableMessage RANDOM
      The sign text to use for marking a stargate as random

    • DISCONNECTED

      public static final TranslatableMessage DISCONNECTED
      The sign text to use for marking a stargate as disconnected

    • BUNGEE_DENY

      public static final TranslatableMessage BUNGEE_DENY
      The message to display when a player is lacking permissions to create a bungee or inter-server network

    • BUNGEE_INVALID_NETWORK

      public static final TranslatableMessage BUNGEE_INVALID_NETWORK
      The message to display if a BungeeCord exit network is invalid

      The message to display if a player is teleporting through BungeeCord and the player cannot be teleported to the destination portal because the network given in the teleportation message is invalid.

    • BUNGEE_INVALID_GATE

      public static final TranslatableMessage BUNGEE_INVALID_GATE
      The message to display if a BungeeCord exit gate is invalid

      The message to display if a player is teleporting through BungeeCord and the player cannot be teleported to the destination portal because the gate given in the teleportation message is invalid.

    • BUNGEE_DISABLED

      public static final TranslatableMessage BUNGEE_DISABLED
      The message to display when a player tries to interact / create / enter a bungee or inter-server gate.

    • INTER_SERVER_DISABLED

      public static final TranslatableMessage INTER_SERVER_DISABLED
      The message to display when a Fancy Inter-server type portal is created, but server is on a local database

    • BUNGEE_SIGN_LINE_4

      public static final TranslatableMessage BUNGEE_SIGN_LINE_4
      The last line on a sign for legacy bungee portals

    • LACKING_FLAGS_PERMISSION

      public static final TranslatableMessage LACKING_FLAGS_PERMISSION
      The message to display

    • BUNGEE_LACKING_SIGN_INFORMATION

      public static final TranslatableMessage BUNGEE_LACKING_SIGN_INFORMATION
      The message to display if creating a legacy BungeeCord portal and the sign is missing information

    • SPAWN_CHUNKS_CONFLICTING

      public static final TranslatableMessage SPAWN_CHUNKS_CONFLICTING
      The message to display if a stargate is created within the spawn area

    • GATE_CREATE_FALLBACK

      public static final TranslatableMessage GATE_CREATE_FALLBACK
      The message to display during portal creation if the chosen network changed

    • COMMAND_RELOAD

      public static final TranslatableMessage COMMAND_RELOAD
      The message to display whenever the reload command is executed

    • COMMAND_INFO

      public static final TranslatableMessage COMMAND_INFO
      The message to display whenever the admin-info is executed

    • COMMAND_HELP

      public static final TranslatableMessage COMMAND_HELP
      The message to display whenever the admin-help is executed

    • GATE_OWNED_BY

      public static final TranslatableMessage GATE_OWNED_BY
      The second line of a portals sign when displaying portal info

    • OUTSIDE_WORLD_BORDER

      public static final TranslatableMessage OUTSIDE_WORLD_BORDER
      The message to send if the player is teleporting past the world-border

    • UNIMPLEMENTED_CONFLICT

      public static final TranslatableMessage UNIMPLEMENTED_CONFLICT
      The message to send when there is an inter-server conflict

    • UNIMPLEMENTED_INTER_SERVER

      public static final TranslatableMessage UNIMPLEMENTED_INTER_SERVER
      The message to send whenever an inter-server portal is created

    • UNIMPLEMENTED_FLAG

      public static final TranslatableMessage UNIMPLEMENTED_FLAG
      The message to send when a flag is not implemented yet

    • GATE

      public static final TranslatableMessage GATE
      The name of a portal

    • NETWORK

      public static final TranslatableMessage NETWORK
      The name of a local network

    • FANCY_INTERSERVER

      public static final TranslatableMessage FANCY_INTERSERVER
      The name of a cross server network

    • DEFAULT_NETWORK

      public static final TranslatableMessage DEFAULT_NETWORK
      The name of the default network

    • TERMINAL_NETWORK

      public static final TranslatableMessage TERMINAL_NETWORK
      The name of a terminal network

    • PERSONAL_NETWORK

      public static final TranslatableMessage PERSONAL_NETWORK
      The name of a personal network

    • CUSTOM_NETWORK

      public static final TranslatableMessage CUSTOM_NETWORK
      The name of a custom network

    • PARITY_UPGRADE

      public static final TranslatableMessage PARITY_UPGRADE
      The message to send when installing parity modules

  • Method Details

    • values

      public static TranslatableMessage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TranslatableMessage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageKey

      public String getMessageKey()
      Gets this translatable message's string key used to identify the message in language files
      Returns:

      This translatable message's string key

    • parse

      public static TranslatableMessage parse(String key)
      Parses the given string key into its enum representation
      Parameters:
      key -

      The string key to parse

      Returns:

      The TranslatableMessage corresponding to the key, or null if not found