Class ClickEvent

    • Method Detail

      • openUrl

        @NotNull
        public static @NotNull ClickEvent openUrl​(@NotNull
                                                  @NotNull String url)
        Creates a click event that opens a url.
        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

        @NotNull
        public static @NotNull ClickEvent changePage​(@NotNull
                                                     @NotNull String 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
      • 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
      • clickEvent

        @NotNull
        public static @NotNull ClickEvent clickEvent​(@NotNull
                                                     @NotNull ClickEvent.Action action,
                                                     @NotNull
                                                     @NotNull String value)
        Creates a click event.
        Parameters:
        action - the action
        value - the value
        Returns:
        a click event
        Since:
        4.0.0
      • action

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

        @NotNull
        public @NotNull String value()
        Gets the click event value.
        Returns:
        the click event value
        Since:
        4.0.0
      • 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