pocketmine\Server Class Reference

Collaboration diagram for pocketmine\Server:

Public Member Functions
	__construct (private ThreadSafeClassLoader $autoloader, private AttachableThreadSafeLogger $logger, string $dataPath, string $pluginPath)
	__debugInfo ()
	addOnlinePlayer (Player $player)
	addOp (string $name)
	addWhitelist (string $name)
	broadcastMessage (Translatable|string $message, ?array $recipients=null)
	broadcastPopup (string $popup, ?array $recipients=null)
	broadcastTip (string $tip, ?array $recipients=null)
	broadcastTitle (string $title, string $subtitle="", int $fadeIn=-1, int $stay=-1, int $fadeOut=-1, ?array $recipients=null)
	crashDump ()
	createPlayer (NetworkSession $session, PlayerInfo $playerInfo, bool $authenticated, ?CompoundTag $offlinePlayerData)
	dispatchCommand (CommandSender $sender, string $commandLine, bool $internal=false)
	enablePlugins (PluginEnableOrder $type)
	exceptionHandler (\Throwable $e, ?array $trace=null)
	forceShutdown ()
	getAllowedViewDistance (int $distance)
	getApiVersion ()
	getAsyncPool ()
	getAuthKeyProvider ()
	getBroadcastChannelSubscribers (string $channelId)
	getCommandAliases ()
	getCommandMap ()
	getConfigGroup ()
	getCraftingManager ()
	getDataPath ()
	getDifficulty ()
	getFilePath ()
	getForceGamemode ()
	getGamemode ()
	getIp ()
	getIPBans ()
	getIpV6 ()
	getLanguage ()
	getLoader ()
	getLogger ()
	getMaxPlayers ()
	getMemoryManager ()
	getMotd ()
	getName ()
	getNameBans ()
	getNetwork ()
	getOfflinePlayer (string $name)
	getOfflinePlayerData (string $name)
	getOnlineMode ()
	getOnlinePlayers ()
	getOps ()
	getPlayerByPrefix (string $name)
	getPlayerByRawUUID (string $rawUUID)
	getPlayerByUUID (UuidInterface $uuid)
	getPlayerExact (string $name)
	getPluginCommand (string $name)
	getPluginManager ()
	getPluginPath ()
	getPocketMineVersion ()
	getPort ()
	getPortV6 ()
	getQueryInformation ()
	getResourcePackManager ()
	getResourcePath ()
	getServerUniqueId ()
	getStartTime ()
	getTick ()
	getTickSleeper ()
	getTicksPerSecond ()
	getTicksPerSecondAverage ()
	getTickUsage ()
	getTickUsageAverage ()
	getUpdater ()
	getVersion ()
	getViewDistance ()
	getWhitelisted ()
	getWorldManager ()
	hasOfflinePlayerData (string $name)
	hasWhitelist ()
	isHardcore ()
	isLanguageForced ()
	isOp (string $name)
	isRunning ()
	isWhitelisted (string $name)
	prepareBatch (string $buffer, Compressor $compressor, ?bool $sync=null, ?TimingsHandler $timings=null)
	removeOnlinePlayer (Player $player)
	removeOp (string $name)
	removeWhitelist (string $name)
	requiresAuthentication ()
	saveOfflinePlayerData (string $name, CompoundTag $nbtTag)
	sendUsage (int $type=SendUsageTask::TYPE_STATUS)
	setMaxPlayers (int $maxPlayers)
	shouldSavePlayerData ()
	shutdown ()
	subscribeToBroadcastChannel (string $channelId, CommandSender $subscriber)
	unsubscribeFromAllBroadcastChannels (CommandSender $subscriber)
	unsubscribeFromBroadcastChannel (string $channelId, CommandSender $subscriber)

Static Public Member Functions
static	getInstance ()

Public Attributes
const	BROADCAST_CHANNEL_ADMINISTRATIVE = "pocketmine.broadcast.admin"
const	BROADCAST_CHANNEL_USERS = "pocketmine.broadcast.user"
const	DEFAULT_MAX_PLAYERS = 20
const	DEFAULT_MAX_VIEW_DISTANCE = 16
const	DEFAULT_PORT_IPV4 = 19132
const	DEFAULT_PORT_IPV6 = 19133
const	DEFAULT_SERVER_NAME = VersionInfo::NAME . " Server"
const	TARGET_NANOSECONDS_PER_TICK = 1_000_000_000 / self::TARGET_TICKS_PER_SECOND
const	TARGET_SECONDS_PER_TICK = 1 / self::TARGET_TICKS_PER_SECOND
const	TARGET_TICKS_PER_SECOND = 20

Detailed Description

The class that manages everything

Definition at line 184 of file src/Server.php.

Constructor & Destructor Documentation

__construct()

pocketmine\Server::__construct	(	private ThreadSafeClassLoader	$autoloader,
		private AttachableThreadSafeLogger	$logger,
		string	$dataPath,
		string	$pluginPath )

Definition at line 777 of file src/Server.php.

Member Function Documentation

__debugInfo()

pocketmine\Server::__debugInfo

(

)

Returns

mixed[]

Definition at line 1748 of file src/Server.php.

addOnlinePlayer()

pocketmine\Server::addOnlinePlayer

(

Player

$player

)

Definition at line 1767 of file src/Server.php.

addOp()

pocketmine\Server::addOp

(

string

$name

)

Definition at line 695 of file src/Server.php.

addWhitelist()

pocketmine\Server::addWhitelist

(

string

$name

)

Definition at line 719 of file src/Server.php.

broadcastMessage()

pocketmine\Server::broadcastMessage	(	Translatable|string	$message,
		?array	$recipients = null )

Parameters

CommandSender[] | null

$recipients

Definition at line 1356 of file src/Server.php.

broadcastPopup()

pocketmine\Server::broadcastPopup	(	string	$popup,
		?array	$recipients = null )

Parameters

Player[] | null

$recipients

Definition at line 1396 of file src/Server.php.

broadcastTip()

pocketmine\Server::broadcastTip	(	string	$tip,
		?array	$recipients = null )

Parameters

Player[] | null

$recipients

Definition at line 1383 of file src/Server.php.

broadcastTitle()

pocketmine\Server::broadcastTitle	(	string	$title,
		string	$subtitle = "",
		int	$fadeIn = -1,
		int	$stay = -1,
		int	$fadeOut = -1,
		?array	$recipients = null )

Parameters

int	$fadeIn	Duration in ticks for fade-in. If -1 is given, client-sided defaults will be used.
int	$stay	Duration in ticks to stay on screen for
int	$fadeOut	Duration in ticks for fade-out.
Player[] | null	$recipients

Definition at line 1412 of file src/Server.php.

crashDump()

pocketmine\Server::crashDump

(

)

Definition at line 1658 of file src/Server.php.

createPlayer()

pocketmine\Server::createPlayer	(	NetworkSession	$session,
		PlayerInfo	$playerInfo,
		bool	$authenticated,
		?CompoundTag	$offlinePlayerData )

@phpstan-return Promise<Player>

Definition at line 567 of file src/Server.php.

dispatchCommand()

pocketmine\Server::dispatchCommand	(	CommandSender	$sender,
		string	$commandLine,
		bool	$internal = false )

Executes a command from a CommandSender

Definition at line 1485 of file src/Server.php.

enablePlugins()

pocketmine\Server::enablePlugins

(

PluginEnableOrder

$type

)

Definition at line 1465 of file src/Server.php.

exceptionHandler()

pocketmine\Server::exceptionHandler	(	\Throwable	$e,
		?array	$trace = null )

Parameters

mixed[][] | null

$trace

@phpstan-param list<array<string, mixed>>|null $trace

Definition at line 1592 of file src/Server.php.

forceShutdown()

pocketmine\Server::forceShutdown

(

)

Definition at line 1514 of file src/Server.php.

getAllowedViewDistance()

pocketmine\Server::getAllowedViewDistance

(

int

$distance

)

Returns a view distance up to the currently-allowed limit.

Definition at line 386 of file src/Server.php.

getApiVersion()

pocketmine\Server::getApiVersion

(

)

Definition at line 328 of file src/Server.php.

getAsyncPool()

pocketmine\Server::getAsyncPool

(

)

Definition at line 459 of file src/Server.php.

getAuthKeyProvider()

pocketmine\Server::getAuthKeyProvider

(

)

Definition at line 1829 of file src/Server.php.

getBroadcastChannelSubscribers()

pocketmine\Server::getBroadcastChannelSubscribers

(

string

$channelId

)

Returns a list of all the CommandSenders subscribed to the given broadcast channel.

Returns

CommandSender[] @phpstan-return array<int, CommandSender>

Definition at line 1349 of file src/Server.php.

getCommandAliases()

pocketmine\Server::getCommandAliases

(

)

Returns

string[][] @phpstan-return array<string, list<string>>

Definition at line 749 of file src/Server.php.

getCommandMap()

pocketmine\Server::getCommandMap

(

)

Definition at line 499 of file src/Server.php.

getConfigGroup()

pocketmine\Server::getConfigGroup

(

)

Definition at line 674 of file src/Server.php.

getCraftingManager()

pocketmine\Server::getCraftingManager

(

)

Definition at line 447 of file src/Server.php.

getDataPath()

pocketmine\Server::getDataPath

(

)

Definition at line 340 of file src/Server.php.

getDifficulty()

pocketmine\Server::getDifficulty

(

)

Returns Server global difficulty. Note that this may be overridden in individual worlds.

Definition at line 415 of file src/Server.php.

getFilePath()

pocketmine\Server::getFilePath

(

)

Definition at line 332 of file src/Server.php.

getForceGamemode()

pocketmine\Server::getForceGamemode

(

)

Definition at line 408 of file src/Server.php.

getGamemode()

pocketmine\Server::getGamemode

(

)

Definition at line 404 of file src/Server.php.

getInstance()

static pocketmine\Server::getInstance ( )

static

Definition at line 770 of file src/Server.php.

getIp()

pocketmine\Server::getIp

(

)

Definition at line 390 of file src/Server.php.

getIPBans()

pocketmine\Server::getIPBans

(

)

Definition at line 691 of file src/Server.php.

getIpV6()

pocketmine\Server::getIpV6

(

)

Definition at line 395 of file src/Server.php.

getLanguage()

pocketmine\Server::getLanguage

(

)

Definition at line 1818 of file src/Server.php.

getLoader()

pocketmine\Server::getLoader

(

)

Definition at line 431 of file src/Server.php.

getLogger()

pocketmine\Server::getLogger

(

)

Definition at line 435 of file src/Server.php.

getMaxPlayers()

pocketmine\Server::getMaxPlayers

(

)

Definition at line 348 of file src/Server.php.

getMemoryManager()

pocketmine\Server::getMemoryManager

(

)

Definition at line 1837 of file src/Server.php.

getMotd()

pocketmine\Server::getMotd

(

)

Definition at line 427 of file src/Server.php.

getName()

pocketmine\Server::getName

(

)

Definition at line 312 of file src/Server.php.

getNameBans()

pocketmine\Server::getNameBans

(

)

Definition at line 687 of file src/Server.php.

getNetwork()

pocketmine\Server::getNetwork

(

)

Definition at line 1833 of file src/Server.php.

getOfflinePlayer()

pocketmine\Server::getOfflinePlayer

(

string

$name

)

Definition at line 514 of file src/Server.php.

getOfflinePlayerData()

pocketmine\Server::getOfflinePlayerData

(

string

$name

)

Definition at line 532 of file src/Server.php.

getOnlineMode()

pocketmine\Server::getOnlineMode

(

)

Returns whether the server requires that players be authenticated to Xbox Live. If true, connecting players who are not logged into Xbox Live will be disconnected.

Definition at line 360 of file src/Server.php.

getOnlinePlayers()

pocketmine\Server::getOnlinePlayers

(

)

Returns

Player[]

Definition at line 506 of file src/Server.php.

Referenced by pocketmine\stats\SendUsageTask\__construct().

Here is the caller graph for this function:

getOps()

pocketmine\Server::getOps

(

)

Definition at line 741 of file src/Server.php.

getPlayerByPrefix()

pocketmine\Server::getPlayerByPrefix

(

string

$name

)

Deprecated

This method's results are unpredictable. The string "Steve" will return the player named "SteveJobs", until another player named "SteveJ" joins the server, at which point it will return that player instead. Prefer filtering the results of Server::getOnlinePlayers() yourself.

Returns an online player whose name begins with or equals the given string (case insensitive). The closest match will be returned, or null if there are no online matches.

See also

Server::getPlayerExact()

Definition at line 626 of file src/Server.php.

getPlayerByRawUUID()

pocketmine\Server::getPlayerByRawUUID

(

string

$rawUUID

)

Returns the player online with the specified raw UUID, or null if not found

Definition at line 663 of file src/Server.php.

getPlayerByUUID()

pocketmine\Server::getPlayerByUUID

(

UuidInterface

$uuid

)

Returns the player online with a UUID equivalent to the specified UuidInterface object, or null if not found

Definition at line 670 of file src/Server.php.

getPlayerExact()

pocketmine\Server::getPlayerExact

(

string

$name

)

Returns an online player with the given name (case insensitive), or null if not found.

Definition at line 649 of file src/Server.php.

getPluginCommand()

pocketmine\Server::getPluginCommand

(

string

$name

)

Returns

Command|PluginOwned|null @phpstan-return (Command&PluginOwned)|null

Definition at line 682 of file src/Server.php.

getPluginManager()

pocketmine\Server::getPluginManager

(

)

Definition at line 443 of file src/Server.php.

getPluginPath()

pocketmine\Server::getPluginPath

(

)

Definition at line 344 of file src/Server.php.

getPocketMineVersion()

pocketmine\Server::getPocketMineVersion

(

)

Definition at line 320 of file src/Server.php.

getPort()

pocketmine\Server::getPort

(

)

Definition at line 371 of file src/Server.php.

getPortV6()

pocketmine\Server::getPortV6

(

)

Definition at line 375 of file src/Server.php.

getQueryInformation()

pocketmine\Server::getQueryInformation

(

)

Definition at line 1584 of file src/Server.php.

getResourcePackManager()

pocketmine\Server::getResourcePackManager

(

)

Definition at line 451 of file src/Server.php.

getResourcePath()

pocketmine\Server::getResourcePath

(

)

Definition at line 336 of file src/Server.php.

getServerUniqueId()

pocketmine\Server::getServerUniqueId

(

)

Definition at line 400 of file src/Server.php.

getStartTime()

pocketmine\Server::getStartTime

(

)

Definition at line 495 of file src/Server.php.

getTick()

pocketmine\Server::getTick

(

)

Definition at line 463 of file src/Server.php.

getTickSleeper()

pocketmine\Server::getTickSleeper

(

)

Definition at line 1752 of file src/Server.php.

getTicksPerSecond()

pocketmine\Server::getTicksPerSecond

(

)

Returns the last server TPS measure

Definition at line 470 of file src/Server.php.

getTicksPerSecondAverage()

pocketmine\Server::getTicksPerSecondAverage

(

)

Returns the last server TPS average measure

Definition at line 477 of file src/Server.php.

Referenced by pocketmine\stats\SendUsageTask\__construct().

Here is the caller graph for this function:

getTickUsage()

pocketmine\Server::getTickUsage

(

)

Returns the TPS usage/load in %

Definition at line 484 of file src/Server.php.

getTickUsageAverage()

pocketmine\Server::getTickUsageAverage

(

)

Returns the TPS usage/load average in %

Definition at line 491 of file src/Server.php.

Referenced by pocketmine\stats\SendUsageTask\__construct().

Here is the caller graph for this function:

getUpdater()

pocketmine\Server::getUpdater

(

)

Definition at line 439 of file src/Server.php.

getVersion()

pocketmine\Server::getVersion

(

)

Definition at line 324 of file src/Server.php.

getViewDistance()

pocketmine\Server::getViewDistance

(

)

Definition at line 379 of file src/Server.php.

getWhitelisted()

pocketmine\Server::getWhitelisted

(

)

Definition at line 737 of file src/Server.php.

getWorldManager()

pocketmine\Server::getWorldManager

(

)

Definition at line 455 of file src/Server.php.

hasOfflinePlayerData()

pocketmine\Server::hasOfflinePlayerData

(

string

$name

)

Returns whether the server has stored any saved data for this player.

Definition at line 528 of file src/Server.php.

hasWhitelist()

pocketmine\Server::hasWhitelist

(

)

Definition at line 419 of file src/Server.php.

isHardcore()

pocketmine\Server::isHardcore

(

)

Definition at line 423 of file src/Server.php.

isLanguageForced()

pocketmine\Server::isLanguageForced

(

)

Definition at line 1822 of file src/Server.php.

isOp()

pocketmine\Server::isOp

(

string

$name

)

Definition at line 733 of file src/Server.php.

isRunning()

pocketmine\Server::isRunning

(

)

Definition at line 316 of file src/Server.php.

isWhitelisted()

pocketmine\Server::isWhitelisted

(

string

$name

)

Definition at line 729 of file src/Server.php.

prepareBatch()

pocketmine\Server::prepareBatch	(	string	$buffer,
		Compressor	$compressor,
		?bool	$sync = null,
		?TimingsHandler	$timings = null )

Definition at line 1435 of file src/Server.php.

removeOnlinePlayer()

pocketmine\Server::removeOnlinePlayer

(

Player

$player

)

Definition at line 1802 of file src/Server.php.

removeOp()

pocketmine\Server::removeOp

(

string

$name

)

Definition at line 704 of file src/Server.php.

removeWhitelist()

pocketmine\Server::removeWhitelist

(

string

$name

)

Definition at line 724 of file src/Server.php.

requiresAuthentication()

pocketmine\Server::requiresAuthentication

(

)

Alias of getOnlineMode().

Definition at line 367 of file src/Server.php.

saveOfflinePlayerData()

pocketmine\Server::saveOfflinePlayerData	(	string	$name,
		CompoundTag	$nbtTag )

Definition at line 544 of file src/Server.php.

sendUsage()

pocketmine\Server::sendUsage

(

int

$type = SendUsageTask::TYPE_STATUS

)

Definition at line 1811 of file src/Server.php.

setMaxPlayers()

pocketmine\Server::setMaxPlayers

(

int

$maxPlayers

)

Definition at line 352 of file src/Server.php.

shouldSavePlayerData()

pocketmine\Server::shouldSavePlayerData

(

)

Definition at line 510 of file src/Server.php.

shutdown()

pocketmine\Server::shutdown

(

)

Shuts the server down correctly

Definition at line 1502 of file src/Server.php.

subscribeToBroadcastChannel()

pocketmine\Server::subscribeToBroadcastChannel	(	string	$channelId,
		CommandSender	$subscriber )

Subscribes to a particular message broadcast channel. The channel ID can be any arbitrary string.

Definition at line 1317 of file src/Server.php.

unsubscribeFromAllBroadcastChannels()

pocketmine\Server::unsubscribeFromAllBroadcastChannels

(

CommandSender

$subscriber

)

Unsubscribes from all broadcast channels.

Definition at line 1337 of file src/Server.php.

unsubscribeFromBroadcastChannel()

pocketmine\Server::unsubscribeFromBroadcastChannel	(	string	$channelId,
		CommandSender	$subscriber )

Unsubscribes from a particular message broadcast channel.

Definition at line 1324 of file src/Server.php.

Member Data Documentation

BROADCAST_CHANNEL_ADMINISTRATIVE

const pocketmine\Server::BROADCAST_CHANNEL_ADMINISTRATIVE = "pocketmine.broadcast.admin"

Definition at line 188 of file src/Server.php.

BROADCAST_CHANNEL_USERS

const pocketmine\Server::BROADCAST_CHANNEL_USERS = "pocketmine.broadcast.user"

Definition at line 189 of file src/Server.php.

DEFAULT_MAX_PLAYERS

const pocketmine\Server::DEFAULT_MAX_PLAYERS = 20

Definition at line 192 of file src/Server.php.

DEFAULT_MAX_VIEW_DISTANCE

const pocketmine\Server::DEFAULT_MAX_VIEW_DISTANCE = 16

Definition at line 195 of file src/Server.php.

DEFAULT_PORT_IPV4

const pocketmine\Server::DEFAULT_PORT_IPV4 = 19132

Definition at line 193 of file src/Server.php.

DEFAULT_PORT_IPV6

const pocketmine\Server::DEFAULT_PORT_IPV6 = 19133

Definition at line 194 of file src/Server.php.

DEFAULT_SERVER_NAME

const pocketmine\Server::DEFAULT_SERVER_NAME = VersionInfo::NAME . " Server"

Definition at line 191 of file src/Server.php.

TARGET_NANOSECONDS_PER_TICK

const pocketmine\Server::TARGET_NANOSECONDS_PER_TICK = 1_000_000_000 / self::TARGET_TICKS_PER_SECOND

Definition at line 207 of file src/Server.php.

TARGET_SECONDS_PER_TICK

const pocketmine\Server::TARGET_SECONDS_PER_TICK = 1 / self::TARGET_TICKS_PER_SECOND

The average time between ticks, in seconds.

Definition at line 206 of file src/Server.php.

TARGET_TICKS_PER_SECOND

const pocketmine\Server::TARGET_TICKS_PER_SECOND = 20

Worlds, network, commands and most other things are polled this many times per second on average. Between ticks, the server will sleep to ensure that the average tick rate is maintained. It may wake up between ticks if a Snooze notification source is triggered (e.g. to process network packets).

Definition at line 202 of file src/Server.php.

---

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

• src/Server.php