PlayerChatEvent Class Reference

Public Member Functions
	__construct (Player $player, $message, $format="chat.type.text", array $recipients=null)
	getMessage ()
	setMessage ($message)
	setPlayer (Player $player)
	getFormat ()
	setFormat ($format)
	getRecipients ()
	setRecipients (array $recipients)
Public Member Functions inherited from PlayerEvent
	getPlayer ()
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()
Public Member Functions inherited from Cancellable
	isCancelled ()
	setCancelled ($forceCancel=false)

Static Public Attributes
static	$handlerList = null

Protected Attributes
	$message
	$format
	$recipients = []
Protected Attributes inherited from PlayerEvent
	$player
Protected Attributes inherited from Event
	$eventName = null

Detailed Description

Called when a player chats something

Constructor & Destructor Documentation

__construct()

__construct	(	Player	$player,
			$message,
			$format = "chat.type.text",
		array	$recipients = null
	)

PlayerChatEvent constructor.

Parameters

Player	$player
	$message
string	$format
array | null	$recipients

                                                                                                               {
        $this->player = $player;
        $this->message = $message;

        $this->format = $format;

        if($recipients === null){
            $this->recipients = Server::getInstance()->getPluginManager()->getPermissionSubscriptions(Server::BROADCAST_CHANNEL_USERS);
        }else{
            $this->recipients = $recipients;
        }
    }

Member Function Documentation

getFormat()

getFormat

(

)

Returns

string

                               {
        return $this->format;
    }

getMessage()

getMessage

(

)

Returns

string

                                {
        return $this->message;
    }

getRecipients()

getRecipients

(

)

Returns

array|Player[]

                                   {
        return $this->recipients;
    }

setFormat()

setFormat

(

$format

)

Parameters

$format

                                      {
        $this->format = $format;
    }

setMessage()

setMessage

(

$message

)

Parameters

$message

                                        {
        $this->message = $message;
    }

setPlayer()

setPlayer

(

Player

$player

)

Changes the player that is sending the message

Parameters

Player

$player

                                             {
        $this->player = $player;
    }

setRecipients()

setRecipients

(

array

$recipients

)

Parameters

array

$recipients

                                                    {
        $this->recipients = $recipients;
    }

Field Documentation

$format

$format

protected

$handlerList

$handlerList = null

static

$message

$message

protected

$recipients

$recipients = []

protected

---

The documentation for this class was generated from the following file:

• src/pocketmine/event/player/PlayerChatEvent.php