Class endstone::BroadcastMessageEvent¶

ClassList > endstone > BroadcastMessageEvent

Event triggered for server broadcast messages such as fromServer::broadcast .More...

#include <endstone/event/server/broadcast_message_event.h>

Inherits the following classes: endstone::Cancellable

Public Static Attributes¶

Type	Name
const std::string	NAME = `"BroadcastMessageEvent"`

Public Functions¶

Type	Name
	BroadcastMessageEvent (bool async, std::string message, std::unordered_set< const CommandSender * > recipients)
virtual std::string	getEventName () override const
const std::string &	getMessage () const
const std::unordered_set< const CommandSender * > &	getRecipients () const
void	setMessage (std::string message)

Public Functions inherited from endstone::Cancellable¶

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual bool	isCancelled () const Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual void	setCancelled (bool cancel) Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Public Functions inherited from endstone::ICancellable¶

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0
virtual bool	isCancelled () const = 0
virtual void	setCancelled (bool cancel) = 0
virtual	~ICancellable () = default

Detailed Description¶

This event should be async if fired from an async thread.

Public Static Attributes Documentation¶

variable NAME¶

const std::string endstone::BroadcastMessageEvent::NAME;

Public Functions Documentation¶

function BroadcastMessageEvent¶

inline endstone::BroadcastMessageEvent::BroadcastMessageEvent (
    bool async,
    std::string message,
    std::unordered_set< const  CommandSender * > recipients
)

function getEventName¶

inline virtual std::string endstone::BroadcastMessageEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

function getMessage¶

inline const std::string & endstone::BroadcastMessageEvent::getMessage () const

Get the message to broadcast.

Returns:

Message to broadcast

function getRecipients¶

inline const std::unordered_set< const  CommandSender * > & endstone::BroadcastMessageEvent::getRecipients () const

Gets a set of recipients that this broadcast message will be displayed to.

Returns:

All CommandSenders who will see this broadcast message

function setMessage¶

inline void endstone::BroadcastMessageEvent::setMessage (
    std::string message
)

Set the message to broadcast.

Parameters:

message New message to broadcast

The documentation for this class was generated from the following file include/endstone/event/server/broadcast_message_event.h