org.spongepowered.api.text.action

Class TextActions

java.lang.Object

org.spongepowered.api.text.action.TextActions

public final class TextActions
extends Object

Utility methods to create instances of TextActions.

Method Summary

Modifier and Type	Method and Description
static ClickAction.ChangePage	changePage(int page) Creates a new ClickAction that will change the page in a book when it is clicked.
static ClickAction.ExecuteCallback	executeCallback(Consumer<CommandSource> callback) Creates a new ClickAction that will execute the given runnable on the server when clicked.
static ShiftClickAction.InsertText	insertText(String text) Creates a new ShiftClickAction that will insert text at the current cursor position in the chat when it is shift-clicked.
static ClickAction.OpenUrl	openUrl(URL url) Creates a new ClickAction that will ask the player to open an URL when it is clicked.
static ClickAction.RunCommand	runCommand(String command) Creates a new ClickAction that will type a command on the client when it is clicked.
static HoverAction.ShowEntity	showEntity(Entity entity, String name) Creates a new HoverAction that will show information about an entity when it is hovered.
static HoverAction.ShowEntity	showEntity(HoverAction.ShowEntity.Ref entity) Creates a new HoverAction that will show information about an entity when it is hovered.
static HoverAction.ShowEntity	showEntity(UUID uuid, String name) Creates a new HoverAction that will show information about an entity when it is hovered.
static HoverAction.ShowEntity	showEntity(UUID uuid, String name, EntityType type) Creates a new HoverAction that will show information about an entity when it is hovered.
static HoverAction.ShowItem	showItem(ItemStackSnapshot item) Creates a new HoverAction that will show information about an item when it is hovered.
static HoverAction.ShowText	showText(Text text) Creates a new HoverAction that will show a text on the client when it is hovered.
static ClickAction.SuggestCommand	suggestCommand(String command) Creates a new ClickAction that will suggest the player a command when it is clicked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

openUrl

public static ClickAction.OpenUrl openUrl(URL url)

Creates a new ClickAction that will ask the player to open an URL when it is clicked.

Parameters:

url - The URL to open

Returns:

The created click action instance

runCommand

public static ClickAction.RunCommand runCommand(String command)

Creates a new ClickAction that will type a command on the client when it is clicked.

Parameters:

command - The command to execute

Returns:

The created click action instance

changePage

public static ClickAction.ChangePage changePage(int page)

Creates a new ClickAction that will change the page in a book when it is clicked.

Parameters:

page - The book page to switch to

Returns:

The created click action instance

suggestCommand

public static ClickAction.SuggestCommand suggestCommand(String command)

Creates a new ClickAction that will suggest the player a command when it is clicked.

Parameters:

command - The command to suggest

Returns:

The created click action instance

executeCallback

public static ClickAction.ExecuteCallback executeCallback(Consumer<CommandSource> callback)

Creates a new ClickAction that will execute the given runnable on the server when clicked. The callback will expire after some amount of time (not particularly instantly, but not like overnight really either).

Parameters:

callback - The callback to execute

Returns:

The created click action instance

showText

public static HoverAction.ShowText showText(Text text)

Creates a new HoverAction that will show a text on the client when it is hovered.

Parameters:

text - The text to display

Returns:

The created hover action instance

showItem

public static HoverAction.ShowItem showItem(ItemStackSnapshot item)

Creates a new HoverAction that will show information about an item when it is hovered.

Parameters:

item - The item to display

Returns:

The created hover action instance

showEntity

public static HoverAction.ShowEntity showEntity(HoverAction.ShowEntity.Ref entity)

Creates a new HoverAction that will show information about an entity when it is hovered.

Parameters:

entity - The entity to display

Returns:

The created hover action instance

showEntity

public static HoverAction.ShowEntity showEntity(UUID uuid,
                                                String name,
                                                @Nullable
                                                EntityType type)

Creates a new HoverAction that will show information about an entity when it is hovered.

Parameters:

uuid - The UUID of the entity

name - The name of the entity

type - The type of the entity

Returns:

The created hover action instance

showEntity

public static HoverAction.ShowEntity showEntity(UUID uuid,
                                                String name)

Creates a new HoverAction that will show information about an entity when it is hovered.

Parameters:

uuid - The UUID of the entity

name - The name of the entity

Returns:

The created hover action instance

showEntity

public static HoverAction.ShowEntity showEntity(Entity entity,
                                                String name)

Creates a new HoverAction that will show information about an entity when it is hovered.

Parameters:

entity - The entity

name - The name of the entity

Returns:

The created hover action instance

insertText

public static ShiftClickAction.InsertText insertText(String text)

Creates a new ShiftClickAction that will insert text at the current cursor position in the chat when it is shift-clicked.

Parameters:

text - The text to insert

Returns:

The created shift click action instance