PlayerChatEvent
extends PlayerEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when a player chats something
Interfaces, Classes, Traits and Enums
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $eventName : string|null
- $format : string
- $message : string
- $player : Player
- $recipients : array<string|int, CommandSender>
- $eventCallDepth : int
- $isCancelled : bool
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getEventName() : string
- getFormat() : string
- getMessage() : string
- getPlayer() : Player
- getRecipients() : array<string|int, CommandSender>
- isCancelled() : bool
- setFormat() : void
- setMessage() : void
- setPlayer() : void
- Changes the player that is sending the message
- setRecipients() : void
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$eventName
protected
string|null
$eventName
= null
$format
protected
string
$format
$message
protected
string
$message
$player
protected
Player
$player
$recipients
protected
array<string|int, CommandSender>
$recipients
= []
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
Methods
__construct()
public
__construct(Player $player, string $message, array<string|int, CommandSender> $recipients[, string $format = "chat.type.text" ]) : mixed
Parameters
- $player : Player
- $message : string
- $recipients : array<string|int, CommandSender>
- $format : string = "chat.type.text"
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getEventName()
public
final getEventName() : string
Return values
string —getFormat()
public
getFormat() : string
Return values
string —getMessage()
public
getMessage() : string
Return values
string —getPlayer()
public
getPlayer() : Player
Return values
Player —getRecipients()
public
getRecipients() : array<string|int, CommandSender>
Return values
array<string|int, CommandSender> —isCancelled()
public
isCancelled() : bool
Return values
bool —setFormat()
public
setFormat(string $format) : void
Parameters
- $format : string
Return values
void —setMessage()
public
setMessage(string $message) : void
Parameters
- $message : string
Return values
void —setPlayer()
Changes the player that is sending the message
public
setPlayer(Player $player) : void
Parameters
- $player : Player
Return values
void —setRecipients()
public
setRecipients(array<string|int, CommandSender> $recipients) : void
Parameters
- $recipients : array<string|int, CommandSender>
Return values
void —uncancel()
public
uncancel() : void