PlayerCreationEvent Class Reference

Public Member Functions
	__construct (SourceInterface $interface, $baseClass, $playerClass, $clientId, $address, $port)
	getInterface ()
	getAddress ()
	getPort ()
	getClientId ()
	getBaseClass ()
	setBaseClass ($class)
	getPlayerClass ()
	setPlayerClass ($class)
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()

Static Public Attributes
static	$handlerList = null

Additional Inherited Members
Protected Attributes inherited from Event
	$eventName = null

Detailed Description

Allows the creation of players overriding the base Player class

Constructor & Destructor Documentation

__construct()

__construct	(	SourceInterface	$interface,
			$baseClass,
			$playerClass,
			$clientId,
			$address,
			$port
	)

Parameters

SourceInterface	$interface
	Player	::class $baseClass
	Player	::class $playerClass
mixed	$clientId
string	$address
int	$port

                                                                                                                 {
        $this->interface = $interface;
        $this->clientId = $clientId;
        $this->address = $address;
        $this->port = $port;

        if(!is_a($baseClass, Player::class, true)){
            throw new \RuntimeException("Base class $baseClass must extend " . Player::class);
        }

        $this->baseClass = $baseClass;

        if(!is_a($playerClass, Player::class, true)){
            throw new \RuntimeException("Class $playerClass must extend " . Player::class);
        }

        $this->playerClass = $playerClass;
    }

Member Function Documentation

getAddress()

getAddress

(

)

Returns

string

                                {
        return $this->address;
    }

getBaseClass()

getBaseClass

(

)

Returns

Player::class

                                  {
        return $this->baseClass;
    }

getClientId()

getClientId

(

)

Returns

mixed

                                 {
        return $this->clientId;
    }

getInterface()

getInterface

(

)

Returns

SourceInterface

                                  {
        return $this->interface;
    }

getPlayerClass()

getPlayerClass

(

)

Returns

Player::class

                                    {
        return $this->playerClass;
    }

getPort()

getPort

(

)

Returns

int

                             {
        return $this->port;
    }

setBaseClass()

setBaseClass

(

$class

)

Parameters

Player

::class $class

                                        {
        if(!is_a($class, $this->baseClass, true)){
            throw new \RuntimeException("Base class $class must extend " . $this->baseClass);
        }

        $this->baseClass = $class;
    }

setPlayerClass()

setPlayerClass

(

$class

)

Parameters

Player

::class $class

                                          {
        if(!is_a($class, $this->baseClass, true)){
            throw new \RuntimeException("Class $class must extend " . $this->baseClass);
        }

        $this->playerClass = $class;
    }

Field Documentation

$handlerList

$handlerList = null

static

---

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

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