io.github.nucleuspowered.nucleus.api.text.event

Interface NucleusTextTemplateEvent

All Superinterfaces:

org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.Event

All Known Subinterfaces:

NucleusTextTemplateEvent.Broadcast

@MightOccurAsync
public interface NucleusTextTemplateEvent
extends org.spongepowered.api.event.Event, org.spongepowered.api.event.Cancellable

Event when messages are sent using NucleusTextTemplates.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusTextTemplateEvent.Broadcast Raised when the text being sent originated as a broadcast.

Method Summary

Modifier and Type	Method and Description
default boolean	containsTokens() Whether the message contains tokens that may be replaced.
NucleusTextTemplate	getMessage() Get the NucleusTextTemplate that will be parsed and sent to players.
default org.spongepowered.api.text.Text	getMessageFor(org.spongepowered.api.command.CommandSource source) Gets the message that would be sent to the specified CommandSource.
NucleusTextTemplate	getOriginalMessage() Get the original NucleusTextTemplate.
java.util.Collection<org.spongepowered.api.command.CommandSource>	getOriginalRecipients() Get the original recipients to send the message to.
java.util.Collection<org.spongepowered.api.command.CommandSource>	getRecipients() Get the recipients to send the message to.
void	setMessage(NucleusTextTemplate message) Sets the message to send to the users getRecipients()
void	setMessage(java.lang.String message) Attempts to set the NucleusTextTemplate message using a string.
void	setRecipients(java.util.Collection<? extends org.spongepowered.api.command.CommandSource> recipients) Set the recipients to send the message to.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getMessage

NucleusTextTemplate getMessage()

Get the NucleusTextTemplate that will be parsed and sent to players.

Returns:

The message

getOriginalMessage

NucleusTextTemplate getOriginalMessage()

Get the original NucleusTextTemplate.

Returns:

The message

setMessage

void setMessage(NucleusTextTemplate message)

Sets the message to send to the users getRecipients()

Parameters:

message - The message to send.

setMessage

void setMessage(java.lang.String message)

Attempts to set the NucleusTextTemplate message using a string.

See NucleusTextTemplateFactory.createFromString(String) for creating the tokens. Also see setMessage(NucleusTextTemplate).

Parameters:

message - The message to send.

getOriginalRecipients

java.util.Collection<org.spongepowered.api.command.CommandSource> getOriginalRecipients()

Get the original recipients to send the message to.

Returns:

The original recipients of the message.

getRecipients

java.util.Collection<org.spongepowered.api.command.CommandSource> getRecipients()

Get the recipients to send the message to.

Returns:

The recipients.

setRecipients

void setRecipients(java.util.Collection<? extends org.spongepowered.api.command.CommandSource> recipients)

Set the recipients to send the message to.

Parameters:

recipients - The recipients.

containsTokens

default boolean containsTokens()

Whether the message contains tokens that may be replaced.

Returns:

true if so.

getMessageFor

default org.spongepowered.api.text.Text getMessageFor(org.spongepowered.api.command.CommandSource source)

Gets the message that would be sent to the specified CommandSource.

Parameters:

source - The source

Returns:

The message for the specific source