Package net.kyori.adventure.text.event

Enum ClickEvent.Action

java.lang.Object
java.lang.Enum<ClickEvent.Action>
net.kyori.adventure.text.event.ClickEvent.Action
All Implemented Interfaces:
Serializable, Comparable<ClickEvent.Action>
Enclosing class:
ClickEvent
public static enum ClickEvent.Action extends Enum<ClickEvent.Action>
An enumeration of click event actions.
Since:
4.0.0

  • Enum Constant Details

    • OPEN_URL

      public static final ClickEvent.Action OPEN_URL
      Opens a url when clicked.
      Since:
      4.0.0

    • OPEN_FILE

      public static final ClickEvent.Action OPEN_FILE
      Opens a file when clicked.

      This action is not readable, and may only be used locally on the client.

      Since:
      4.0.0

    • RUN_COMMAND

      public static final ClickEvent.Action RUN_COMMAND
      Runs a command when clicked.
      Since:
      4.0.0

    • SUGGEST_COMMAND

      public static final ClickEvent.Action SUGGEST_COMMAND
      Suggests a command into the chat box.
      Since:
      4.0.0

    • CHANGE_PAGE

      public static final ClickEvent.Action CHANGE_PAGE
      Changes the page of a book.
      Since:
      4.0.0

    • COPY_TO_CLIPBOARD

      public static final ClickEvent.Action COPY_TO_CLIPBOARD
      Copies text to the clipboard.
      Since:
      4.0.0
      Since Minecraft:
      1.15

    • SHOW_DIALOG

      public static final ClickEvent.Action SHOW_DIALOG
      Shows a dialog.

      This action is not readable at this time until Adventure has a full Dialog API.

      Since:
      4.22.0
      Since Minecraft:
      1.21.6

    • CUSTOM

      public static final ClickEvent.Action CUSTOM
      Sends a custom event to the server.
      Since:
      4.22.0
      Since Minecraft:
      1.21.6

  • Field Details

  • Method Details

    • values

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

    • valueOf

      public static ClickEvent.Action valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • readable

      public boolean readable()
      Tests if this action is readable.
      Returns:
      true if this action is readable, false if this action is not readable
      Since:
      4.0.0

    • supports

      public boolean supports(@NotNull @NotNull ClickEvent.Payload payload)
      Returns if this action supports the provided payload.
      Parameters:
      payload - the payload
      Returns:
      true if this action supports the payload
      Since:
      4.22.0

    • payloadType

      @NotNull public @NotNull Class<? extends ClickEvent.Payload> payloadType()
      The type of the payload this click event supports.
      Returns:
      the payload type
      Since:
      4.22.0

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Enum<ClickEvent.Action>