PlayerKickEvent Class Reference

Public Member Functions
	__construct (Player $player, $reason, $quitMessage)
	getReason ()
	setQuitMessage ($quitMessage)
	getQuitMessage ()
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
	$quitMessage
	$reason
Protected Attributes inherited from PlayerEvent
	$player
Protected Attributes inherited from Event
	$eventName = null

Detailed Description

Called when a player leaves the server

Constructor & Destructor Documentation

__construct()

__construct	(	Player	$player,
			$reason,
			$quitMessage
	)

PlayerKickEvent constructor.

Parameters

Player	$player
	$reason
	$quitMessage

                                                                      {
        $this->player = $player;
        $this->quitMessage = $quitMessage;
        $this->reason = $reason;
    }

Member Function Documentation

getQuitMessage()

getQuitMessage

(

)

Returns

string

                                    {
        return $this->quitMessage;
    }

getReason()

getReason

(

)

Returns

string

                               {
        return $this->reason;
    }

setQuitMessage()

setQuitMessage

(

$quitMessage

)

Parameters

$quitMessage

                                                {
        $this->quitMessage = $quitMessage;
    }

Field Documentation

$handlerList

$handlerList = null

static

$quitMessage

$quitMessage

protected

$reason

$reason

protected

---

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

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