ProxyNetwork 5.46.0

interface · pocketmine\network\proxy\ProxyNetwork · source

The pm-proxy network this server belongs to (network.proxy in pocketmine.yml), for plugins. Get it with \pocketmine\Server::getProxyNetwork(), which returns null when the server is not behind pm-proxy.

What it knows about other servers comes from the proxy about once a second, so it can be slightly out of date.

Constants

STYLE_CINEMATIC

public const STYLE_CINEMATIC = "cinematic"

Transfer style: like seamless, with the camera flying up and down (GTA V style).

STYLE_DIMENSION

public const STYLE_DIMENSION = "dimension"

Transfer style: a dimension change with its loading screen.

STYLE_SEAMLESS

public const STYLE_SEAMLESS = "seamless"

Transfer style: no loading screen, the terrain is replaced (same dimension only, else dimension).

TARGET_HUB

public const TARGET_HUB = "@hub"

Transfer target meaning the lobby (the proxy's fallback groups).

Methods

broadcastAlert()

public function broadcastAlert(string $message) : void

Shows a chat message to every player of the network.

findPlayer()

public function findPlayer(string $name) : ?string

The server a player of the network is on (name matched without case), or null if not online.

getGlobalPlayerCount()

public function getGlobalPlayerCount() : int

Players on the whole network.

getGroups()

public function getGroups() : array

Groups of servers of the network (a group sends players to its least busy server).

getOnlinePlayers()

public function getOnlinePlayers() : array

Every player of the network, with the server it is on ("" while changing server).

getServerName()

public function getServerName() : string

Name of this server in the network (network.proxy.server-name).

getServerPlayerCount()

public function getServerPlayerCount(string $server) : int

Players on a server of the network (0 for unknown servers).

getServers()

public function getServers() : array

Servers of the network.

isConnected()

public function isConnected() : bool

Whether the proxy is linked right now. While it is not, players cannot join and nothing is sent.

isNetworkTarget()

public function isNetworkTarget(string $name) : bool

Whether a name is a server or a group of the network.

isServerOnline()

public function isServerOnline(string $server) : bool

Whether the proxy has a working link to a server of the network.

sendMessage()

public function sendMessage(string $channel, string $data, ?string $server = null) : void

Sends a plugin message to another server (or to every other server when $server is null). It arrives there as a \pocketmine\event\server\ProxyMessageReceiveEvent.

sendPlayer()

public function sendPlayer(string $name, string $target, string $style = "") : void

Moves a player of any server of the network, by name ("*" for everyone).

transfer()

public function transfer(\pocketmine\player\Player $player, string $target, string $style = "") : bool

Moves a player of this server to a server or group of the network (or self::TARGET_HUB), without reconnecting. Calls \pocketmine\event\player\PlayerProxyTransferEvent.