Package ch.njol.skript.util.chat

Enum Class SkriptChatCode

java.lang.Object
java.lang.Enum<SkriptChatCode>
ch.njol.skript.util.chat.SkriptChatCode
All Implemented Interfaces:
ChatCode, Serializable, Comparable<SkriptChatCode>, Constable
@Deprecated(since="2.15", forRemoval=true) public enum SkriptChatCode extends Enum<SkriptChatCode> implements ChatCode
Deprecated, for removal: This API element is subject to removal in a future version.
See TextComponentParser.
Chat codes that come with Skript by default.

  • 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
    aqua
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    black
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    blue
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    bold
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    change_page
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    copy_to_clipboard
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_aqua
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_blue
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_gray
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_green
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_purple
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    dark_red
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    font
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    gold
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    gray
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    green
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    insertion
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    italic
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    keybind
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    light_purple
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    obfuscated
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    open_url
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    red
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    reset
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    run_command
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    show_text
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    strikethrough
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    suggest_command
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    translate
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    underlined
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    white
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    yellow
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    getColorChar()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the color char that is an alternative way to use this chat code.
    @Nullable String
    getColorCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets color code of this chat code.
    @Nullable String
    getLangName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Name to be used in scripts.
    boolean
    hasParam()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if this chat code takes a string parameter.
    boolean
    isLocalized()
    Deprecated, for removal: This API element is subject to removal in a future version.
    For internal usage.
    void
    updateComponent(MessageComponent component, String param)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies style of this chat code to given component.
    static SkriptChatCode
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static SkriptChatCode[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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

    • reset

      public static final SkriptChatCode reset
      Deprecated, for removal: This API element is subject to removal in a future version.

    • black

      public static final SkriptChatCode black
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_blue

      public static final SkriptChatCode dark_blue
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_green

      public static final SkriptChatCode dark_green
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_aqua

      public static final SkriptChatCode dark_aqua
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_red

      public static final SkriptChatCode dark_red
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_purple

      public static final SkriptChatCode dark_purple
      Deprecated, for removal: This API element is subject to removal in a future version.

    • gold

      public static final SkriptChatCode gold
      Deprecated, for removal: This API element is subject to removal in a future version.

    • gray

      public static final SkriptChatCode gray
      Deprecated, for removal: This API element is subject to removal in a future version.

    • dark_gray

      public static final SkriptChatCode dark_gray
      Deprecated, for removal: This API element is subject to removal in a future version.

    • blue

      public static final SkriptChatCode blue
      Deprecated, for removal: This API element is subject to removal in a future version.

    • green

      public static final SkriptChatCode green
      Deprecated, for removal: This API element is subject to removal in a future version.

    • aqua

      public static final SkriptChatCode aqua
      Deprecated, for removal: This API element is subject to removal in a future version.

    • red

      public static final SkriptChatCode red
      Deprecated, for removal: This API element is subject to removal in a future version.

    • light_purple

      public static final SkriptChatCode light_purple
      Deprecated, for removal: This API element is subject to removal in a future version.

    • yellow

      public static final SkriptChatCode yellow
      Deprecated, for removal: This API element is subject to removal in a future version.

    • white

      public static final SkriptChatCode white
      Deprecated, for removal: This API element is subject to removal in a future version.

    • bold

      public static final SkriptChatCode bold
      Deprecated, for removal: This API element is subject to removal in a future version.

    • italic

      public static final SkriptChatCode italic
      Deprecated, for removal: This API element is subject to removal in a future version.

    • underlined

      public static final SkriptChatCode underlined
      Deprecated, for removal: This API element is subject to removal in a future version.

    • strikethrough

      public static final SkriptChatCode strikethrough
      Deprecated, for removal: This API element is subject to removal in a future version.

    • obfuscated

      public static final SkriptChatCode obfuscated
      Deprecated, for removal: This API element is subject to removal in a future version.

    • open_url

      public static final SkriptChatCode open_url
      Deprecated, for removal: This API element is subject to removal in a future version.

    • run_command

      public static final SkriptChatCode run_command
      Deprecated, for removal: This API element is subject to removal in a future version.

    • suggest_command

      public static final SkriptChatCode suggest_command
      Deprecated, for removal: This API element is subject to removal in a future version.

    • change_page

      public static final SkriptChatCode change_page
      Deprecated, for removal: This API element is subject to removal in a future version.

    • copy_to_clipboard

      public static final SkriptChatCode copy_to_clipboard
      Deprecated, for removal: This API element is subject to removal in a future version.

    • show_text

      public static final SkriptChatCode show_text
      Deprecated, for removal: This API element is subject to removal in a future version.

    • font

      public static final SkriptChatCode font
      Deprecated, for removal: This API element is subject to removal in a future version.

    • insertion

      public static final SkriptChatCode insertion
      Deprecated, for removal: This API element is subject to removal in a future version.

    • translate

      public static final SkriptChatCode translate
      Deprecated, for removal: This API element is subject to removal in a future version.

    • keybind

      public static final SkriptChatCode keybind
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • values

      public static SkriptChatCode[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 SkriptChatCode valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • hasParam

      public boolean hasParam()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      Checks if this chat code takes a string parameter. If yes, scripters will use it like: <name:param>
      Specified by:
      hasParam in interface ChatCode
      Returns:

    • getColorCode

      @Nullable public @Nullable String getColorCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      Gets color code of this chat code. Skript will apply it automatically. Note that setting color code is usually not useful for addon developers, because Skript supports all colors that Minecraft client does.

      If null is returned, ChatCode.updateComponent(MessageComponent, String) is called instead. You probably want that, as it is more versatile.

      Specified by:
      getColorCode in interface ChatCode
      Returns:
      Color code.

    • getLangName

      @Nullable public @Nullable String getLangName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      Name to be used in scripts. if ChatCode.isLocalized() is true, this is used as a language file key instead.
      Specified by:
      getLangName in interface ChatCode
      Returns:
      Name in language file.

    • isLocalized

      public boolean isLocalized()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      For internal usage.
      Specified by:
      isLocalized in interface ChatCode
      Returns:
      True for Skript's color codes.

    • getColorChar

      public char getColorChar()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      Gets the color char that is an alternative way to use this chat code. Return 0 unless you wish to use a color char.

      If not 0, it can be used in scripts in following way: &x or §x, if the code is x. It is not case sensitive if you return a character from which there is upper case character available. If you return the upper case character, lower case variant cannot be used in scripts (so don't do that).

      Specified by:
      getColorChar in interface ChatCode
      Returns:
      Color char.

    • updateComponent

      public void updateComponent(MessageComponent component, String param)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ChatCode
      Applies style of this chat code to given component.
      Specified by:
      updateComponent in interface ChatCode
      Parameters:
      component - Component to update.
      param - String parameter. May be empty string.