Package net.kyori.adventure.text.event

Class ClickEvent

java.lang.Object
net.kyori.adventure.text.event.ClickEvent
All Implemented Interfaces:
ComponentBuilderApplicable, StyleBuilderApplicable, net.kyori.examination.Examinable
public final class ClickEvent extends Object implements net.kyori.examination.Examinable, StyleBuilderApplicable
A click event.

A click event processes an ClickEvent.Action when clicked on.

Since:
4.0.0

  • Method Details

    • openUrl

      @NotNull public static @NotNull ClickEvent openUrl(@NotNull @NotNull String url)
      Creates a click event that opens a url.

      Since Minecraft: Java Edition 1.21.5 the url will fail to parse if not a http:// or https:// scheme.

      Parameters:
      url - the url to open
      Returns:
      a click event
      Since:
      4.0.0

    • openUrl

      @NotNull public static @NotNull ClickEvent openUrl(@NotNull @NotNull URL url)
      Creates a click event that opens a url.
      Parameters:
      url - the url to open
      Returns:
      a click event
      Since:
      4.0.0

    • openFile

      @NotNull public static @NotNull ClickEvent openFile(@NotNull @NotNull String file)
      Creates a click event that opens a file.

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

      Parameters:
      file - the file to open
      Returns:
      a click event
      Since:
      4.0.0

    • runCommand

      @NotNull public static @NotNull ClickEvent runCommand(@NotNull @NotNull String command)
      Creates a click event that runs a command.
      Parameters:
      command - the command to run
      Returns:
      a click event
      Since:
      4.0.0

    • suggestCommand

      @NotNull public static @NotNull ClickEvent suggestCommand(@NotNull @NotNull String command)
      Creates a click event that suggests a command.
      Parameters:
      command - the command to suggest
      Returns:
      a click event
      Since:
      4.0.0

    • changePage

      @Deprecated @NotNull public static @NotNull ClickEvent changePage(@NotNull @NotNull String page)
      Deprecated.
      For removal since 4.22.0, pages are integers, use changePage(int)
      Creates a click event that changes to a page.
      Parameters:
      page - the page to change to
      Returns:
      a click event
      Throws:
      IllegalArgumentException - if the page cannot be represented as an integer using
      Since:
      4.0.0

    • changePage

      @NotNull public static @NotNull ClickEvent changePage(int page)
      Creates a click event that changes to a page.
      Parameters:
      page - the page to change to
      Returns:
      a click event
      Since:
      4.0.0

    • copyToClipboard

      @NotNull public static @NotNull ClickEvent copyToClipboard(@NotNull @NotNull String text)
      Creates a click event that copies text to the clipboard.
      Parameters:
      text - the text to copy to the clipboard
      Returns:
      a click event
      Since:
      4.0.0
      Since Minecraft:
      1.15

    • callback

      @NotNull public static @NotNull ClickEvent callback(@NotNull @NotNull ClickCallback<Audience> function)
      Create a click event that, when clicked, will schedule a callback function to be executed on the server.

      By default, this will be a single-use function that expires after the value of ClickCallback.DEFAULT_LIFETIME.

      Parameters:
      function - the function to execute
      Returns:
      a callback click event
      Since:
      4.13.0

    • callback

      @NotNull public static @NotNull ClickEvent callback(@NotNull @NotNull ClickCallback<Audience> function, @NotNull ClickCallback.Options options)
      Create a click event that, when clicked, will schedule a callback function to be executed on the server.
      Parameters:
      function - the function to execute
      options - options to control how the callback will be stored on the server.
      Returns:
      a callback click event
      Since:
      4.13.0

    • callback

      @NotNull public static @NotNull ClickEvent callback(@NotNull @NotNull ClickCallback<Audience> function, @NotNull @NotNull Consumer<@NotNull ClickCallback.Options.Builder> optionsBuilder)
      Create a click event that, when clicked, will schedule a callback function to be executed on the server.
      Parameters:
      function - the function to execute
      optionsBuilder - function that will be called to configure the click callback options
      Returns:
      a callback click event
      Since:
      4.13.0

    • showDialog

      @NotNull public static @NotNull ClickEvent showDialog(@NotNull @NotNull DialogLike dialog)
      Creates a click event that shows a dialog.
      Parameters:
      dialog - the dialog
      Returns:
      the click event
      Since:
      4.22.0

    • custom

      @Deprecated @NotNull public static @NotNull ClickEvent custom(@NotNull @NotNull Key key, @NotNull @NotNull String data)
      Deprecated.
      For removal since 4.23.0, payloads hold NBT data, use custom(Key, BinaryTagHolder) instead. This method will create NBT using BinaryTagHolder.binaryTagHolder(String).
      Creates a click event sends a custom event to the server.
      Parameters:
      key - the key
      data - the data
      Returns:
      the click event
      Since:
      4.22.0

    • custom

      @NotNull public static @NotNull ClickEvent custom(@NotNull @NotNull Key key, @NotNull @NotNull BinaryTagHolder nbt)
      Creates a click event that sends a custom event to the server.

      See BinaryTagHolder.binaryTagHolder(String) for a simple way to create NBT from SNBT. For simple use cases, you can use plain strings directly as SNBT.

      Parameters:
      key - the key identifying the payload
      nbt - the nbt data
      Returns:
      the click event
      Since:
      4.23.0

    • clickEvent

      @Deprecated @NotNull public static @NotNull ClickEvent clickEvent(@NotNull @NotNull ClickEvent.Action action, @NotNull @NotNull String value)
      Deprecated.
      For removal since 4.22.0, not all actions support string payloads. Use clickEvent(Action, Payload) or the event-specific methods.
      Creates a click event with a string payload.
      Parameters:
      action - the action
      value - the value
      Returns:
      a click event
      Throws:
      IllegalArgumentException - if the action does not support a string payload
      Since:
      4.0.0

    • clickEvent

      @NotNull public static @NotNull ClickEvent clickEvent(@NotNull @NotNull ClickEvent.Action action, @NotNull @NotNull ClickEvent.Payload payload)
      Creates a click event with a payload.
      Parameters:
      action - the action
      payload - the payload
      Returns:
      a click event
      Throws:
      IllegalArgumentException - if the action does not support that payload
      Since:
      4.25.0

    • action

      @NotNull public @NotNull ClickEvent.Action action()
      Gets the click event action.
      Returns:
      the click event action
      Since:
      4.0.0

    • value

      @Deprecated @NotNull public @NotNull String value()
      Deprecated.
      For removal since 4.22.0, click events can hold more than just strings, see payload()
      Gets the click event value if the payload is a string payload.
      Returns:
      the click event value
      Throws:
      IllegalStateException - if the payload is not a string payload
      Since:
      4.0.0

    • payload

      @NotNull public @NotNull ClickEvent.Payload payload()
      Gets the payload associated with this click event.
      Returns:
      the payload
      Since:
      4.22.0

    • styleApply

      public void styleApply(@NotNull Style.Builder style)
      Description copied from interface: StyleBuilderApplicable
      Applies to style.
      Specified by:
      styleApply in interface StyleBuilderApplicable
      Parameters:
      style - the style builder

    • equals

      public boolean equals(@Nullable @Nullable Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • examinableProperties

      @NotNull public @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
      Specified by:
      examinableProperties in interface net.kyori.examination.Examinable

    • toString

      public String toString()
      Overrides:
      toString in class Object