Cancellable
public class BroadcastMessageEvent extends ServerEvent implements Cancellable
Server.broadcast(String, String)
.
This event behaves similarly to AsyncPlayerChatEvent
in that it
should be async if fired from an async thread. Please see that event for
further information.Event.Result
Constructor | Description |
---|---|
BroadcastMessageEvent(boolean isAsync,
@NotNull String message,
@NotNull Set<CommandSender> recipients) |
|
BroadcastMessageEvent(@NotNull String message,
@NotNull Set<CommandSender> recipients) |
Deprecated.
|
Modifier and Type | Method | Description |
---|---|---|
static @NotNull HandlerList |
getHandlerList() |
|
@NotNull HandlerList |
getHandlers() |
|
@NotNull String |
getMessage() |
Get the message to broadcast.
|
@NotNull Set<CommandSender> |
getRecipients() |
Gets a set of recipients that this chat message will be displayed to.
|
boolean |
isCancelled() |
Gets the cancellation state of this event.
|
void |
setCancelled(boolean cancelled) |
Sets the cancellation state of this event.
|
void |
setMessage(@NotNull String message) |
Set the message to broadcast.
|
getEventName, isAsynchronous
@Deprecated public BroadcastMessageEvent(@NotNull @NotNull String message, @NotNull @NotNull Set<CommandSender> recipients)
public BroadcastMessageEvent(boolean isAsync, @NotNull @NotNull String message, @NotNull @NotNull Set<CommandSender> recipients)
@NotNull public @NotNull String getMessage()
public void setMessage(@NotNull @NotNull String message)
message
- New message to broadcast@NotNull public @NotNull Set<CommandSender> getRecipients()
The set returned is not guaranteed to be mutable and may auto-populate on access. Any listener accessing the returned set should be aware that it may reduce performance for a lazy set implementation.
Listeners should be aware that modifying the list may throw UnsupportedOperationException
if the event caller provides an
unmodifiable set.
public boolean isCancelled()
Cancellable
isCancelled
in interface Cancellable
public void setCancelled(boolean cancelled)
Cancellable
setCancelled
in interface Cancellable
cancelled
- true if you wish to cancel this event@NotNull public @NotNull HandlerList getHandlers()
getHandlers
in class Event
@NotNull public static @NotNull HandlerList getHandlerList()
Copyright © 2020. All rights reserved.