Inheritance diagram for Phpcraft\ClientConnection:

[legend]

Collaboration diagram for Phpcraft\ClientConnection:

[legend]

Public Member Functions
	__construct ($stream, ?Server &$server=null)

	handleInitialPacket ()

	disconnect ($reason=[])

	startPacket ($packet)

	getHost ()

	sendEncryptionRequest ($private_key)

	handleEncryptionResponse ($private_key)

	isAuthenticationPending ()

	handleAuthentication ()

	finishLogin (UUID $uuid, Counter $eidCounter, int $compression_threshold=256)

	teleport (Point3D $pos, ?float $yaw=null, ?float $pitch=null)

	rotate (int $yaw, int $pitch)

	getEyePosition ()

	getUnitVector ()

	sendAdminBroadcast ($message, string $permission="everything")

	sendMessage ($message, int $position=ChatPosition::SYSTEM)

	getServer ()

	hasPermission (string $permission)

	setGamemode (int $gamemode)

	sendAbilities ()

	setAbilitiesFromGamemode (int $gamemode)

	getName ()

	hasPosition ()

	getPosition ()

Public Member Functions inherited from Phpcraft\Connection
	__construct (int $protocol_version=-1, $stream=null)

	isOpen ()

	setReadBuffer (string $buffer)

	getRemainingData ()

	writeChat ($value)

	writeString (string $value)

	writeRaw (string $value)

	writeFloat (float $value)

	writePosition (Point3D $pos)

	writeLong ($value)

	writePrecisePosition (Point3D $pos)

	writeDouble (float $value)

	writeFixedPointPosition (Point3D $pos)

	writeInt ($value)

	writeSlot (Slot $slot)

	writeBoolean (bool $value)

	writeShort ($value)

	writeVarInt ($value)

	writeByte (int $value)

	writeUnsignedShort ($value)

	writeUnsignedByte (int $value)

	writeAngle (float $value)

	writeUUID (UUID $uuid)

	send (bool $raw=false)

	close ()

	readRawPacket (float $timeout=3.000, int $bytes=0)

	getRemoteAddress ()

	readPacket (float $timeout=3.000)

	readVarInt ()

	readUnsignedByte ()

	readAngle ()

	readByte ()

	readChat ()

	readString (int $maxLength=32767, int $minLength=-1)

	readPosition ()

	readPrecisePosition ()

	readDouble ()

	readFixedPointPosition ()

	readInt ()

	readUUID ()

	readSlot (bool $additional_processing=true)

	readBoolean ()

	readShort ()

	readNBT (int $type=0)

	readRaw (int $bytes)

	readLong ()

	readFloat ()

	readUnsignedShort ()

	ignoreBytes (int $bytes)

Public Member Functions inherited from Phpcraft\Command\CommandSender
	sendMessage ($message)

Public Attributes
	$hostname

	$hostport

	$join_specs = []

	$username

	$uuid

	$config

	$next_heartbeat = 0

	$disconnect_after = 0

	$eid

	$pos

	$chunk_x

	$chunk_z

	$yaw = 0

	$pitch = 0

	$tpidCounter

	$tp_confirm_deadline = 0

	$on_ground = false

	$render_distance = 8

	$chunks = []

	$gamemode = Gamemode::SURVIVAL

	$entityMetadata

	$invulnerable = false

	$flying = false

	$can_fly = false

	$instant_breaking = false

	$fly_speed = 0.05

	$walk_speed = 0.1

Public Attributes inherited from Phpcraft\Connection
const	STATE_HANDSHAKE = 0

const	STATE_STATUS = 1

const	STATE_LOGIN = 2

const	STATE_PLAY = 3

	$protocol_version

	$stream

	$compression_threshold = -1

	$state

	$write_buffer = ""

	$read_buffer = ""

	$read_buffer_offset = 0

Additional Inherited Members
Static Public Member Functions inherited from Phpcraft\Connection
static	varInt ($value)

Static Public Attributes inherited from Phpcraft\Connection
static	$zero

static	$pow2 = []

Detailed Description

A server-to-client connection.

Constructor & Destructor Documentation

◆ __construct()

Phpcraft\ClientConnection::__construct	(		$stream,
		?Server &	$server = `null`
	)

After this, you should call ClientConnection::handleInitialPacket().

Parameters

resource	$stream
Server \| null	$server

Member Function Documentation

◆ disconnect()

Phpcraft\ClientConnection::disconnect ( $reason = [] )

Disconnects the client with a reason.

Parameters

array | string $reason The reason of the disconnect; chat object.

Returns: void

◆ finishLogin()

Phpcraft\ClientConnection::finishLogin	(	UUID	$uuid,
		Counter	$eidCounter,
		int	$compression_threshold = `256`
	)

Sets the compression threshold and finishes the login.

Parameters

UUID	$uuid	The UUID of the client.
Counter	$eidCounter	The server's Counter to assign an entity ID to the client.
int	$compression_threshold	The amount of bytes a packet needs to have before it is compressed. Use -1 to disable compression. Compression will always be disabled on loopback connections.

Returns: ClientConnection $this

Exceptions

IOException

◆ getEyePosition()

Phpcraft\ClientConnection::getEyePosition ( )

◆ getHost()

Phpcraft\ClientConnection::getHost ( )

Returns the host the client had connected to, e.g. localhost:25565. Note that SRV records are pre-connection redirects, so if _minecraft._tcp.example.com points to mc.example.com which is an A or AAAA record, this will return mc.example.com:25565.

Returns: string

◆ getName()

Phpcraft\ClientConnection::getName ( )

Returns: string

Implements Phpcraft\Command\CommandSender.

◆ getPosition()

Phpcraft\ClientConnection::getPosition ( )

Returns: Point3D|null

Implements Phpcraft\Command\CommandSender.

◆ getServer()

Phpcraft\ClientConnection::getServer ( )

Returns: Server

Implements Phpcraft\Command\ServerCommandSender.

◆ getUnitVector()

Phpcraft\ClientConnection::getUnitVector ( )

Returns a unit vector goin in the direction the client is looking.

Returns: Point3D

◆ handleAuthentication()

Phpcraft\ClientConnection::handleAuthentication ( )

Checks if the asynchronous authentication with Mojang has finished. In case of an error, the client is disconnected and 0 is returned. If Mojang's response was not yet received, 1 is returned. If Mojang's response was received and the authentication was successful, an array such as this is returned:

[
  "id" => "11111111222233334444555555555555",
  "name" => "Notch",
  "properties" => [
    [
      "name" => "textures",
      "value" => "<base64 string>",
      "signature" => "<base64 string; signed data using Yggdrasil's private key>"
    ]
  ]
]

Returns: int|array

See also: ClientConnection::isAuthenticationPending

◆ handleEncryptionResponse()

Phpcraft\ClientConnection::handleEncryptionResponse ( $private_key )

Reads an encryption response packet and starts asynchronous authentication with Mojang. This requires ClientConnection::$username to be set. In case of an error, the client is disconnected and false is returned. Otherwise, true is returned, and ClientConnection::handleAuthentication should be regularly called to finish the authentication.

Parameters

resource $private_key Your OpenSSL private key resource.

Returns: boolean

Exceptions

IOException

◆ handleInitialPacket()

Phpcraft\ClientConnection::handleInitialPacket ( )

Deals with the first packet the client has sent. This function deals with the handshake or legacy list ping packet. Errors will cause the connection to be closed.

Returns: int Status: 0 = The client is yet to present an initial packet. 1 = Handshake was successfully read; use Connection::$state to see if the client wants to get the status (1) or login to play (2). 2 = A legacy list ping packet has been received. 3 = An error occured and the connection has been closed.

◆ hasPermission()

Phpcraft\ClientConnection::hasPermission ( string $permission )

Parameters

string $permission

Returns: bool

Implements Phpcraft\Command\CommandSender.

◆ hasPosition()

Phpcraft\ClientConnection::hasPosition ( )

Returns: bool

Implements Phpcraft\Command\CommandSender.

◆ isAuthenticationPending()

Phpcraft\ClientConnection::isAuthenticationPending ( )

Returns true if an asynchronous authentication with Mojang is still pending.

Returns: boolean

See also: ClientConnection::handleAuthentication

◆ rotate()

Phpcraft\ClientConnection::rotate	(	int	$yaw,
		int	$pitch
	)

Changes the client's rotation.

Parameters

int	$yaw
int	$pitch

Returns: ClientConnection $this

Exceptions

IOException

◆ sendAbilities()

Phpcraft\ClientConnection::sendAbilities ( )

Sends the client their abilities.

Returns: ClientConnection $this

Exceptions

IOException

See also: ClientConnection::$invulnerable; ClientConnection::$flying; ClientConnection::$can_fly; ClientConnection::$instant_breaking; ClientConnection::$fly_speed; ClientConnection::$walk_speed

◆ sendAdminBroadcast()

Phpcraft\ClientConnection::sendAdminBroadcast	(		$message,
		string	$permission = `"everything"`
	)

Sends a message to the client and "[{$this->username}: $message]" to the server console and players with the given permission.

Parameters

array \| string	$message
string	$permission

Returns: void

Exceptions

IOException

Implements Phpcraft\Command\CommandSender.

◆ sendEncryptionRequest()

Phpcraft\ClientConnection::sendEncryptionRequest ( $private_key )

Sends an Encryption Request Packet.

Parameters

resource $private_key Your OpenSSL private key resource.

Returns: ClientConnection $this

Exceptions

IOException

◆ sendMessage()

Phpcraft\ClientConnection::sendMessage	(		$message,
		int	$position = `ChatPosition::SYSTEM`
	)

Sends the client a chat message.

Parameters

array \| string	$message
int	$position

Returns: void

Exceptions

IOException

◆ setAbilitiesFromGamemode()

Phpcraft\ClientConnection::setAbilitiesFromGamemode ( int $gamemode )

Sets the client's abilities according to the given gamemode.

Parameters

int $gamemode

Returns: ClientConnection $this

See also: ClientConnection::sendAbilities; ClientConnection::setGamemode

◆ setGamemode()

Phpcraft\ClientConnection::setGamemode ( int $gamemode )

Sets the client's gamemode and adjusts their abilities accordingly.

Parameters

int $gamemode

Returns: ClientConnection $this

Exceptions

IOException

See also: Gamemode

◆ startPacket()

Phpcraft\ClientConnection::startPacket ( $packet )

Clears the write buffer and starts a new packet.

Parameters

string | integer $packet The name or ID of the new packet.

Returns: Connection $this

Reimplemented from Phpcraft\Connection.

◆ teleport()

Phpcraft\ClientConnection::teleport	(	Point3D	$pos,
		?float	$yaw = `null`,
		?float	$pitch = `null`
	)

Teleports the client to the given position, and optionally, changes their rotation.

Parameters

Point3D	$pos
float \| null	$yaw
float \| null	$pitch

Returns: ClientConnection $this

Exceptions

IOException

Member Data Documentation

◆ $can_fly

boolean Phpcraft\ClientConnection::$can_fly = false

See also: ClientConnection::sendAbilities

◆ $chunk_x

int null Phpcraft\ClientConnection::$chunk_x

◆ $chunk_z

int null Phpcraft\ClientConnection::$chunk_z

◆ $chunks

array< string > Phpcraft\ClientConnection::$chunks = []

A string array of chunks the client has received.

◆ $config

ClientConfiguration Phpcraft\ClientConnection::$config

◆ $disconnect_after

float Phpcraft\ClientConnection::$disconnect_after = 0

This variable is for servers to keep track of how long clients have to answer keep alive packets.

◆ $eid

GMP Phpcraft\ClientConnection::$eid

The client's entity ID.

◆ $entityMetadata

Player null Phpcraft\ClientConnection::$entityMetadata

◆ $fly_speed

float Phpcraft\ClientConnection::$fly_speed = 0.05

See also: ClientConnection::sendAbilities

◆ $flying

boolean Phpcraft\ClientConnection::$flying = false

See also: ClientConnection::sendAbilities; ServerFlyChangeEvent

◆ $gamemode

int Phpcraft\ClientConnection::$gamemode = Gamemode::SURVIVAL

◆ $hostname

string Phpcraft\ClientConnection::$hostname

The hostname the client had connected to.

See also: ClientConnection::getHost; ClientConnection::handleInitialPacket

◆ $hostport

int Phpcraft\ClientConnection::$hostport

The port the client had connected to.

See also: ClientConnection::handleInitialPacket; ClientConnection::getHost

◆ $instant_breaking

boolean Phpcraft\ClientConnection::$instant_breaking = false

See also: ClientConnection::sendAbilities; ClientConnection::setGamemode

◆ $invulnerable

boolean Phpcraft\ClientConnection::$invulnerable = false

See also: ClientConnection::sendAbilities

◆ $join_specs

array< string > Phpcraft\ClientConnection::$join_specs = []

Additional data the client had provided in the handshake. E.g., "FML" is in this array for Forge clients.

◆ $next_heartbeat

float Phpcraft\ClientConnection::$next_heartbeat = 0

This variable is for servers to keep track of when to send the next keep alive packet to clients.

◆ $on_ground

boolean Phpcraft\ClientConnection::$on_ground = false

See also: ServerOnGroundChangeEvent

◆ $pitch

float Phpcraft\ClientConnection::$pitch = 0

The client's rotation on the Y axis, -90 to 90.

◆ $pos

Point3D Phpcraft\ClientConnection::$pos

The client's position.

◆ $render_distance

int Phpcraft\ClientConnection::$render_distance = 8

◆ $tp_confirm_deadline

float Phpcraft\ClientConnection::$tp_confirm_deadline = 0

◆ $tpidCounter

Counter Phpcraft\ClientConnection::$tpidCounter

◆ $username

string Phpcraft\ClientConnection::$username

The client's in-game name.

◆ $uuid

UUID Phpcraft\ClientConnection::$uuid

The UUID of the client.

◆ $walk_speed

float Phpcraft\ClientConnection::$walk_speed = 0.1

See also: ClientConnection::sendAbilities

◆ $yaw

float Phpcraft\ClientConnection::$yaw = 0

The client's rotation on the X axis, 0 to 359.9.

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ disconnect()

◆ finishLogin()

◆ getEyePosition()

◆ getHost()

◆ getName()

◆ getPosition()

◆ getServer()

◆ getUnitVector()

◆ handleAuthentication()

◆ handleEncryptionResponse()

◆ handleInitialPacket()

◆ hasPermission()

◆ hasPosition()

◆ isAuthenticationPending()

◆ rotate()

◆ sendAbilities()

◆ sendAdminBroadcast()

◆ sendEncryptionRequest()

◆ sendMessage()

◆ setAbilitiesFromGamemode()

◆ setGamemode()

◆ startPacket()

◆ teleport()

Member Data Documentation

◆ $can_fly

◆ $chunk_x

◆ $chunk_z

◆ $chunks

◆ $config

◆ $disconnect_after

◆ $eid

◆ $entityMetadata

◆ $fly_speed

◆ $flying

◆ $gamemode

◆ $hostname

◆ $hostport

◆ $instant_breaking

◆ $invulnerable

◆ $join_specs

◆ $next_heartbeat

◆ $on_ground

◆ $pitch

◆ $pos

◆ $render_distance

◆ $tp_confirm_deadline

◆ $tpidCounter

◆ $username

◆ $uuid

◆ $walk_speed

◆ $yaw