me.croabeast.beanslib.builder

Class ChatMessageBuilder

java.lang.Object

me.croabeast.beanslib.builder.ChatMessageBuilder

All Implemented Interfaces:

Cloneable

public class ChatMessageBuilder
extends Object
implements Cloneable

A builder class for creating complex chat messages in Minecraft. Allows for setting hover and click actions on individual parts of the message.

Every string that is appended is being colorized using NeoPrismaticAPI color formatting, and placeholders are being replaced if a Player parser variable is defined.

Constructor Summary

Constructors

Constructor and Description
ChatMessageBuilder() Constructs a new ChatMessageBuilder object without any initial string.
ChatMessageBuilder(org.bukkit.entity.Player target, org.bukkit.entity.Player parser, String string) Constructs a new ChatMessageBuilder object from a string message.
ChatMessageBuilder(org.bukkit.entity.Player player, String string) Constructs a new ChatMessageBuilder object from a string message.
ChatMessageBuilder(String string) Constructs a new ChatMessageBuilder object from a string message.

Method Summary

Modifier and Type	Method and Description
ChatMessageBuilder	append(String string)
<T> ChatMessageBuilder	append(T object)
@NotNull net.md_5.bungee.api.chat.BaseComponent[]	build()
ChatMessageBuilder	clone()
boolean	send()
ChatMessageBuilder	setClick(ClickAction type, String action)
ChatMessageBuilder	setClick(String input)
ChatMessageBuilder	setClick(String type, String action)
ChatMessageBuilder	setClickToAll(ClickAction type, String action)
ChatMessageBuilder	setClickToAll(String input)
ChatMessageBuilder	setHover(List<String> hover)
ChatMessageBuilder	setHover(String... hover)
ChatMessageBuilder	setHoverToAll(List<String> hover)
ChatMessageBuilder	setParseURLs(boolean b)
String	toPatternString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatMessageBuilder

public ChatMessageBuilder(org.bukkit.entity.Player target,
                          org.bukkit.entity.Player parser,
                          String string)

Constructs a new ChatMessageBuilder object from a string message.

Parameters:

target - the player that will receive the chat builder

parser - the player to parse placeholders and colors

string - the string message to construct the builder from

ChatMessageBuilder

public ChatMessageBuilder(org.bukkit.entity.Player player,
                          String string)

Constructs a new ChatMessageBuilder object from a string message.

Parameters:

player - the player to parse placeholders and colors

string - the string message to construct the builder from

ChatMessageBuilder

public ChatMessageBuilder(String string)

Constructs a new ChatMessageBuilder object from a string message.

Parameters:

string - the string message to construct the builder from

ChatMessageBuilder

public ChatMessageBuilder()

Constructs a new ChatMessageBuilder object without any initial string.

The append(String) method should be called at least once before building it.

Method Detail

setParseURLs

public ChatMessageBuilder setParseURLs(boolean b)

setHover

public ChatMessageBuilder setHover(List<String> hover)

setHover

public ChatMessageBuilder setHover(String... hover)

setHoverToAll

public ChatMessageBuilder setHoverToAll(List<String> hover)

setClick

public ChatMessageBuilder setClick(ClickAction type,
                                   String action)

setClick

public ChatMessageBuilder setClick(String type,
                                   String action)

setClick

public ChatMessageBuilder setClick(String input)

setClickToAll

public ChatMessageBuilder setClickToAll(ClickAction type,
                                        String action)

setClickToAll

public ChatMessageBuilder setClickToAll(String input)

append

public ChatMessageBuilder append(String string)

append

public <T> ChatMessageBuilder append(T object)

build

@NotNull
public @NotNull net.md_5.bungee.api.chat.BaseComponent[] build()

send

public boolean send()

toPatternString

public String toPatternString()

toString

public String toString()

Overrides:

toString in class Object

clone

public ChatMessageBuilder clone()

Overrides:

clone in class Object