Public Member Functions
	getName ()

	isRunning ()

	getUptime ()

	getPocketMineVersion ()

	getFormattedVersion ($prefix="")

	getCodename ()

	getVersion ()

	getApiVersion ()

	getiTXApiVersion ()

	getGeniApiVersion ()

	getFilePath ()

	getDataPath ()

	getPluginPath ()

	getMaxPlayers ()

	getPort ()

	getViewDistance ()

	getAllowedViewDistance (int $distance)

	getIp ()

	getServerUniqueId ()

	getAutoSave ()

	setAutoSave ($value)

	getLevelType ()

	getGenerateStructures ()

	getGamemode ()

	getForceGamemode ()

	getDifficulty ()

	hasWhitelist ()

	getSpawnRadius ()

	getAllowFlight ()

	isHardcore ()

	getDefaultGamemode ()

	getMotd ()

	getLoader ()

	getLogger ()

	getEntityMetadata ()

	getPlayerMetadata ()

	getLevelMetadata ()

	getPluginManager ()

	getCraftingManager ()

	getScheduler ()

	getTick ()

	getTicksPerSecond ()

	getTicksPerSecondAverage ()

	getTickUsage ()

	getTickUsageAverage ()

	getCommandMap ()

	getOnlinePlayers ()

	addRecipe (Recipe $recipe)

	shouldSavePlayerData ()

	getOfflinePlayer ($name)

	getOfflinePlayerData ($name)

	saveOfflinePlayerData ($name, CompoundTag $nbtTag, $async=false)

	getPlayer (string $name)

	getPlayerExact (string $name)

	matchPlayer ($partialName)

	removePlayer (Player $player)

	getLevels ()

	getDefaultLevel ()

	setDefaultLevel ($level)

	isLevelLoaded ($name)

	getLevel ($levelId)

	getLevelByName ($name)

	unloadLevel (Level $level, $forceUnload=false)

	loadLevel ($name)

	isLevelGenerated ($name)

	getConfigString ($variable, $defaultValue="")

	getProperty ($variable, $defaultValue=null)

	setConfigString ($variable, $value)

	getConfigInt ($variable, $defaultValue=0)

	setConfigInt ($variable, $value)

	getConfigBoolean ($variable, $defaultValue=false)

	setConfigBool ($variable, $value)

	getPluginCommand ($name)

	getNameBans ()

	getIPBans ()

	getCIDBans ()

	addOp ($name)

	removeOp ($name)

	addWhitelist ($name)

	removeWhitelist ($name)

	isWhitelisted ($name)

	isOp ($name)

	getWhitelisted ()

	getOps ()

	reloadWhitelist ()

	getCommandAliases ()

	getCrashPath ()

	about ()

	loadAdvancedConfig ()

	isSynapseEnabled ()

	getDServerMaxPlayers ()

	getDServerOnlinePlayers ()

	isDServerEnabled ()

	updateDServerInfo ()

	getBuild ()

	getGameVersion ()

	__construct (\ClassLoader $autoloader,\ThreadedLogger $logger, $filePath, $dataPath, $pluginPath, $defaultLang="unknown")

	broadcastPacket (array $players, DataPacket $packet)

	batchPackets (array $players, array $packets, $forceSync=false)

	broadcastPacketsCallback ($data, array $identifiers)

	enablePlugins (int $type)

	enablePlugin (Plugin $plugin)

	disablePlugins ()

	checkConsole ()

	dispatchCommand (CommandSender $sender, $commandLine)

	reload ()

	shutdown (bool $restart=false, string $msg="")

	forceShutdown ()

	getQueryInformation ()

	start ()

	handleSignal ($signo)

	exceptionHandler (\Throwable $e, $trace=null)

	crashDump ()

	__debugInfo ()

	onPlayerLogin (Player $player)

	addPlayer ($identifier, Player $player)

	addOnlinePlayer (Player $player)

	removeOnlinePlayer (Player $player)

	updatePlayerListData (UUID $uuid, $entityId, $name, $skinId, $skinData, array $players=null)

	removePlayerListData (UUID $uuid, array $players=null)

	sendFullPlayerListData (Player $p)

	doAutoSave ()

	sendUsage ($type=SendUsageTask::TYPE_STATUS)

	getLanguage ()

	isLanguageForced ()

	getNetwork ()

	getMemoryManager ()

	handlePacket ($address, $port, $payload)

	getAdvancedProperty ($variable, $defaultValue=null, Config $cfg=null)

	updateQuery ()

Static Public Member Functions
static	getGamemodeString ($mode)

static	getGamemodeFromString ($str)

static	getDifficultyFromString ($str)

static	getInstance ()

static	microSleep (int $microseconds)

Data Fields
const	BROADCAST_CHANNEL_ADMINISTRATIVE = "pocketmine.broadcast.admin"

const	BROADCAST_CHANNEL_USERS = "pocketmine.broadcast.user"

const	PLAYER_MSG_TYPE_MESSAGE = 0

const	PLAYER_MSG_TYPE_TIP = 1

const	PLAYER_MSG_TYPE_POPUP = 2

	$networkCompressionLevel = 7

	$advancedConfig = null

	$weatherEnabled = true

	$foodEnabled = true

	$expEnabled = true

	$keepInventory = false

	$netherEnabled = false

	$netherName = "nether"

	$weatherRandomDurationMin = 6000

	$weatherRandomDurationMax = 12000

	$lightningTime = 200

	$lightningFire = false

	$version

	$allowSnowGolem

	$allowIronGolem

	$autoClearInv = true

	$dserverConfig = []

	$dserverPlayers = 0

	$dserverAllPlayers = 0

	$redstoneEnabled = false

	$allowFrequencyPulse = true

	$anvilEnabled = false

	$pulseFrequency = 20

	$playerMsgType = self::PLAYER_MSG_TYPE_MESSAGE

	$playerLoginMsg = ""

	$playerLogoutMsg = ""

	$keepExperience = false

	$limitedCreative = true

	$chunkRadius = -1

	$destroyBlockParticle = true

	$allowSplashPotion = true

	$fireSpread = false

	$advancedCommandSelector = false

	$enchantingTableEnabled = true

	$countBookshelf = false

	$allowInventoryCheats = false

Detailed Description

The class that manages everything

Constructor & Destructor Documentation

__construct	(	\ClassLoader	$autoloader,
		\ThreadedLogger	$logger,
			$filePath,
			$dataPath,
			$pluginPath,
			$defaultLang = `"unknown"`
	)

Parameters

\ClassLoader	$autoloader
\ThreadedLogger	$logger
string	$filePath
string	$dataPath
string	$pluginPath
string	$defaultLang

Member Function Documentation

addOp ( $name )

Parameters

string $name

addWhitelist ( $name )

Parameters

string $name

batchPackets	(	array	$players,
		array	$packets,
			$forceSync = `false`
	)

Broadcasts a list of packets in a batch to a list of players

Parameters

	Player[]	$players
	DataPacket[]\|string	$packets
bool	$forceSync

broadcastPacket	(	array	$players,
		DataPacket	$packet
	)

Broadcasts a Minecraft packet to a list of players

Parameters

	Player[]	$players
DataPacket	$packet

dispatchCommand	(	CommandSender	$sender,
			$commandLine
	)

Executes a command from a CommandSender

Parameters

CommandSender	$sender
string	$commandLine

Returns: bool

enablePlugin ( Plugin $plugin )

Parameters

Plugin $plugin

enablePlugins ( int $type )

Parameters

int $type

getAdvancedProperty	(		$variable,
			$defaultValue = `null`,
		Config	$cfg = `null`
	)

Parameters

	$variable
null	$defaultValue
Config \| null	$cfg

Returns: bool|mixed|null

getAllowedViewDistance ( int $distance )

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

Parameters

int $distance

Returns: int

getAllowFlight ( )

Returns: bool

getApiVersion ( )

Returns: string

getAutoSave ( )

Returns: bool

getCodename ( )

Returns: string

getCommandAliases ( )

Returns: string[]

getCommandMap ( )

Returns: SimpleCommandMap

getConfigBoolean	(	$variable,
		$defaultValue = `false`
	)

Parameters

string	$variable
boolean	$defaultValue

Returns: boolean

getConfigInt	(	$variable,
		$defaultValue = `0`
	)

Parameters

string	$variable
int	$defaultValue

Returns: int

getConfigString	(	$variable,
		$defaultValue = `""`
	)

Parameters

string	$variable
string	$defaultValue

Returns: string

getCraftingManager ( )

Returns: CraftingManager

getDataPath ( )

Returns: string

getDefaultGamemode ( )

Returns: int

getDefaultLevel ( )

Returns: Level

getDifficulty ( )

Returns: int

static getDifficultyFromString ( $str )

static

Parameters

string $str

Returns: int

getDServerMaxPlayers ( )

Returns: int

Get DServer max players

getDServerOnlinePlayers ( )

Returns: int

Get DServer all online player count

getEntityMetadata ( )

Returns: EntityMetadataStore

getFilePath ( )

Returns: string

getForceGamemode ( )

Returns: bool

getGamemode ( )

Returns: int

static getGamemodeFromString ( $str )

static

Parses a string and returns a gamemode integer, -1 if not found

Parameters

string $str

Returns: int

static getGamemodeString ( $mode )

static

Returns the gamemode text name

Parameters

int $mode

Returns: string

getGenerateStructures ( )

Returns: bool

getGeniApiVersion ( )

Returns: string

static getInstance ( )

static

Returns: Server

getIp ( )

Returns: string

getIPBans ( )

Returns: BanList

getiTXApiVersion ( )

Returns: string

getLanguage ( )

Returns: BaseLang

getLevel ( $levelId )

Parameters

int $levelId

Returns: Level

getLevelByName ( $name )

Parameters

$name

Returns: Level

getLevelMetadata ( )

Returns: LevelMetadataStore

getLevels ( )

Returns: Level[]

getLevelType ( )

Returns: string

getLoader ( )

Returns

getLogger ( )

Returns: MainLogger

getMaxPlayers ( )

Returns: int

getMemoryManager ( )

Returns: MemoryManager

getMotd ( )

Returns: string

getName ( )

Returns: string

getNameBans ( )

Returns: BanList

getNetwork ( )

Returns: Network

getOfflinePlayer ( $name )

Parameters

string $name

Returns: OfflinePlayer|Player

getOfflinePlayerData ( $name )

Parameters

string $name

Returns: CompoundTag

getOnlinePlayers ( )

Returns: Player[]

getOps ( )

Returns: Config

getPlayer ( string $name )

Parameters

string $name

Returns: Player

getPlayerExact ( string $name )

Parameters

string $name

Returns: Player

getPlayerMetadata ( )

Returns: PlayerMetadataStore

getPluginCommand ( $name )

Parameters

string $name

Returns: PluginIdentifiableCommand

getPluginManager ( )

Returns: PluginManager

getPluginPath ( )

Returns: string

getPocketMineVersion ( )

Returns: string

getPort ( )

Returns: int

getProperty	(	$variable,
		$defaultValue = `null`
	)

Parameters

string	$variable
mixed	$defaultValue

Returns: mixed

getScheduler ( )

Returns: ServerScheduler

getSpawnRadius ( )

Returns: int

getTick ( )

Returns: int

getTicksPerSecond ( )

Returns the last server TPS measure

Returns: float

getTicksPerSecondAverage ( )

Returns the last server TPS average measure

Returns: float

getTickUsage ( )

Returns the TPS usage/load in %

Returns: float

getTickUsageAverage ( )

Returns the TPS usage/load average in %

Returns: float

getUptime ( )

Returns: string Returns a formatted string of how long the server has been running for

getVersion ( )

Returns: string

getViewDistance ( )

Returns: int

getWhitelisted ( )

Returns: Config

handlePacket	(	$address,
		$port,
		$payload
	)

Parameters

string	$address
int	$port
string	$payload	TODO: move this to Network

hasWhitelist ( )

Returns: bool

isHardcore ( )

Returns: bool

isLanguageForced ( )

Returns: bool

isLevelGenerated ( $name )

Parameters

string $name

Returns: bool

isLevelLoaded ( $name )

Parameters

string $name

Returns: bool

isOp ( $name )

Parameters

string $name

Returns: bool

isRunning ( )

Returns: bool

isSynapseEnabled ( )

Deprecated:: Use SynapsePM plugin instead

Returns: bool

isWhitelisted ( $name )

Parameters

string $name

Returns: bool

loadLevel ( $name )

Loads a level from the data directory

Parameters

string $name

Returns: bool

Exceptions

LevelException

matchPlayer ( $partialName )

Parameters

string $partialName

Returns: Player[]

removeOp ( $name )

Parameters

string $name

removePlayer ( Player $player )

Parameters

Player $player

removeWhitelist ( $name )

Parameters

string $name

saveOfflinePlayerData	(		$name,
		CompoundTag	$nbtTag,
			$async = `false`
	)

Parameters

string	$name
CompoundTag	$nbtTag
bool	$async

setAutoSave ( $value )

Parameters

bool $value

setConfigBool	(	$variable,
		$value
	)

Parameters

string	$variable
bool	$value

setConfigInt	(	$variable,
		$value
	)

Parameters

string	$variable
int	$value

setConfigString	(	$variable,
		$value
	)

Parameters

string	$variable
string	$value

setDefaultLevel ( $level )

Sets the default level to a different level This won't change the level-name property, it only affects the server on runtime

Parameters

Level $level

shutdown	(	bool	$restart = `false`,
		string	$msg = `""`
	)

Shutdowns the server correctly

Parameters

bool	$restart
string	$msg

start ( )

Starts the PocketMine-MP server and starts processing ticks and packets

unloadLevel	(	Level	$level,
			$forceUnload = `false`
	)

Parameters

Level	$level
bool	$forceUnload

Returns: bool

Field Documentation

$advancedConfig = null

Advanced Config

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

src/pocketmine/Server.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation