pocketmine Namespace Reference

Namespaces
	block
	command
	entity
	event
	inventory
	item
	lang
	level
	math
	metadata
	nbt
	network
	permission
	plugin
	resourcepacks
	scheduler
	tile
	utils
	wizard

Data Structures
class	Achievement
class	CrashDump
interface	IPlayer
class	MemoryManager
class	OfflinePlayer
class	Player
class	Server
class	Thread
class	ThreadManager
class	Worker

Functions
	detect_system_timezone ()
	parse_offset ($offset)
if(isset($opts["enable-profiler"]))	kill ($pid)
	getReferenceCount ($value, $includeCurrent=true)
	getTrace ($start=1, $trace=null)
	cleanPath ($path)

Variables
const	VERSION = "1.1dev"
const	API_VERSION = "3.0.1"
const	CODENAME = "LlamaSpit"
const	GENISYS_API_VERSION = '2.0.0'
if(\Phar::running(true) !=="")	else
if(version_compare("7.0", PHP_VERSION) > 0) if(!extension_loaded("pthreads")) if(!class_exists("ClassLoader", false))	$autoloader = new \BaseClassLoader()
const	START_TIME microtime(true)
	$opts = getopt("", ["data:", "plugins:", "no-wizard", "enable-profiler"])
const	DATA isset($opts["data"]) ? $opts["data"] . DIRECTORY_SEPARATOR : \getcwd() . DIRECTORY_SEPARATOR
const	PLUGIN_PATH isset($opts["plugins"]) ? $opts["plugins"] . DIRECTORY_SEPARATOR : \getcwd() . DIRECTORY_SEPARATOR . "plugins" . DIRECTORY_SEPARATOR
const	ANSI Terminal::hasFormattingCodes()
	$logger = new MainLogger(\pocketmine\DATA . "server.log", \pocketmine\ANSI)
	$errors = 0
if(php_sapi_name() !=="cli") if(!extension_loaded("sockets"))	$pthreads_version = phpversion("pthreads")
const	ENDIANNESS (!defined('pocketmine\GIT_COMMIT')) (pack("d", 1) === "\77\360\0\0\0\0\0\0" ? Binary::BIG_ENDIAN : Binary::LITTLE_ENDIAN)
const	INT32_MASK is_int(0xffffffff) ? 0xffffffff : -1
	$killer = new ServerKiller(8)
	$erroredThreads = 0

Function Documentation

cleanPath()

pocketmine\cleanPath

(

$path

)

Parameters

$path

Returns

string

                             {
        return rtrim(str_replace(["\\", ".php", "phar://", rtrim(str_replace(["\\", "phar://"], ["/", ""], \pocketmine\PATH), "/"), rtrim(str_replace(["\\", "phar://"], ["/", ""], \pocketmine\PLUGIN_PATH), "/")], ["/", "", "", "", ""], $path), "/");
    }

    $errors = 0;

    if(php_sapi_name() !== "cli"){
        $logger->critical("You must run GenisysPro using the CLI.");
        ++$errors;
    }

    if(!extension_loaded("sockets")){
        $logger->critical("Unable to find the Socket extension.");
        ++$errors;
    }

    $pthreads_version = phpversion("pthreads");
    if(substr_count($pthreads_version, ".") < 2){
        $pthreads_version = "0.$pthreads_version";
    }
    if(version_compare($pthreads_version, "3.1.5") < 0){
        $logger->critical("pthreads >= 3.1.5 is required, while you have $pthreads_version.");
        ++$errors;
    }

    if(!extension_loaded("uopz")){
        //$logger->notice("Couldn't find the uopz extension. Some functions may be limited");
    }

    if(extension_loaded("pocketmine")){
        if(version_compare(phpversion("pocketmine"), "0.0.1") < 0){
            $logger->critical("You have the native GenisysPro extension, but your version is lower than 0.0.1.");
            ++$errors;
        }elseif(version_compare(phpversion("pocketmine"), "0.0.4") > 0){
            $logger->critical("You have the native GenisysPro extension, but your version is higher than 0.0.4.");
            ++$errors;
        }
    }

    if(extension_loaded("xdebug")){
        $logger->warning("You are running GenisysPro with Xdebug enabled. This has a major impact on performance.");
    }

    if(!extension_loaded("curl")){
        $logger->critical("Unable to find the cURL extension.");
        ++$errors;
    }

    if(!extension_loaded("yaml")){
        $logger->critical("Unable to find the YAML extension.");
        ++$errors;
    }

    if(!extension_loaded("zlib")){
        $logger->critical("Unable to find the Zlib extension.");
        ++$errors;
    }

    if($errors > 0){
        $logger->critical("Please update or recompile PHP.");
        $logger->shutdown();
        $logger->join();
        exit(1); //Exit with error
    }

    if(file_exists(\pocketmine\PATH . ".git/HEAD")){ //Found Git information!
        $ref = trim(file_get_contents(\pocketmine\PATH . ".git/HEAD"));
        if(preg_match('/^[0-9a-f]{40}$/i', $ref)){
            define('pocketmine\GIT_COMMIT', strtolower($ref));
        }elseif(substr($ref, 0, 5) === "ref: "){
            $refFile = \pocketmine\PATH . ".git/" . substr(trim(file_get_contents(\pocketmine\PATH . ".git/HEAD")), 5);
            if(is_file($refFile)){
                define('pocketmine\GIT_COMMIT', strtolower(trim(file_get_contents($refFile))));
            }
        }
    }
    if(!defined('pocketmine\GIT_COMMIT')){
        define('pocketmine\GIT_COMMIT', "0000000000000000000000000000000000000000");
    }

    @define("ENDIANNESS", (pack("d", 1) === "\77\360\0\0\0\0\0\0" ? Binary::BIG_ENDIAN : Binary::LITTLE_ENDIAN));
    @define("INT32_MASK", is_int(0xffffffff) ? 0xffffffff : -1);
    @ini_set("opcache.mmap_base", bin2hex(random_bytes(8))); //Fix OPCache address errors

    if(!file_exists(\pocketmine\DATA . "server.properties") and !isset($opts["no-wizard"])){
        $installer = new Installer();
        if(!$installer->run()){
            $logger->shutdown();
            $logger->join();
            exit(-1);
        }
    }

    if(\Phar::running(true) === ""){
        $logger->warning("Non-packaged GenisysPro installation detected, do not use on production.");
    }

    ThreadManager::init();
    new Server($autoloader, $logger, \pocketmine\PATH, \pocketmine\DATA, \pocketmine\PLUGIN_PATH);

    $logger->info("Stopping other threads");

    $killer = new ServerKiller(8);
    $killer->start();
    usleep(10000); //Fixes ServerKiller not being able to start on single-core machines

    $erroredThreads = 0;
    foreach(ThreadManager::getInstance()->getAll() as $id => $thread){
        $logger->debug("Stopping " . $thread->getThreadName() . " thread");
        try{
            $thread->quit();
            $logger->debug($thread->getThreadName() . " thread stopped successfully.");
        }catch(\ThreadException $e){
            ++$erroredThreads;
            $logger->debug("Could not stop " . $thread->getThreadName() . " thread: " . $e->getMessage());
        }
    }

    $logger->shutdown();
    $logger->join();

    echo Terminal::$FORMAT_RESET . PHP_EOL;

    if($erroredThreads > 0){
        if(\pocketmine\DEBUG > 1){
            echo "Some threads could not be stopped, performing a force-kill" . PHP_EOL . PHP_EOL;
        }
        kill(getmypid());
    }else{

detect_system_timezone()

pocketmine\detect_system_timezone

(

)

Returns

bool|string

                                     {
        switch(Utils::getOS()){
            case 'win':
                $regex = '/(UTC)(\+*\-*\d*\d*\:*\d*\d*)/';

                /*
                 * wmic timezone get Caption
                 * Get the timezone offset
                 *
                 * Sample Output var_dump
                 * array(3) {
                 *    [0] =>
                 *    string(7) "Caption"
                 *    [1] =>
                 *    string(20) "(UTC+09:30) Adelaide"
                 *    [2] =>
                 *    string(0) ""
                 *  }
                 */
                exec("wmic timezone get Caption", $output);

                $string = trim(implode("\n", $output));

                //Detect the Time Zone string
                preg_match($regex, $string, $matches);

                if(!isset($matches[2])){
                    return false;
                }

                $offset = $matches[2];

                if($offset == ""){
                    return "UTC";
                }

                return parse_offset($offset);
            case 'linux':
                // Ubuntu / Debian.
                if(file_exists('/etc/timezone')){
                    $data = file_get_contents('/etc/timezone');
                    if($data){
                        return trim($data);
                    }
                }

                // RHEL / CentOS
                if(file_exists('/etc/sysconfig/clock')){
                    $data = parse_ini_file('/etc/sysconfig/clock');
                    if(!empty($data['ZONE'])){
                        return trim($data['ZONE']);
                    }
                }

                //Portable method for incompatible linux distributions.

                $offset = trim(exec('date +%:z'));

                if($offset == "+00:00"){
                    return "UTC";
                }

                return parse_offset($offset);
            case 'mac':
                if(is_link('/etc/localtime')){
                    $filename = readlink('/etc/localtime');
                    if(strpos($filename, '/usr/share/zoneinfo/') === 0){
                        $timezone = substr($filename, 20);
                        return trim($timezone);
                    }
                }

                return false;
            default:
                return false;
        }
    }

getReferenceCount()

pocketmine\getReferenceCount	(		$value,
			$includeCurrent = true
	)

Parameters

object	$value
bool	$includeCurrent

Returns

int

                                                              {
        ob_start();
        debug_zval_dump($value);
        $ret = explode("\n", ob_get_contents());
        ob_end_clean();

        if(count($ret) >= 1 and preg_match('/^.* refcount\\(([0-9]+)\\)\\{$/', trim($ret[0]), $m) > 0){
            return ((int) $m[1]) - ($includeCurrent ? 3 : 4); //$value + zval call + extra call
        }
        return -1;
    }

getTrace()

pocketmine\getTrace	(		$start = 1,
			$trace = null
	)

Parameters

int	$start
null	$trace

Returns

array

                                                {
        if($trace === null){
            if(function_exists("xdebug_get_function_stack")){
                $trace = array_reverse(xdebug_get_function_stack());
            }else{
                $e = new \Exception();
                $trace = $e->getTrace();
            }
        }

        $messages = [];
        $j = 0;
        for($i = (int) $start; isset($trace[$i]); ++$i, ++$j){
            $params = "";
            if(isset($trace[$i]["args"]) or isset($trace[$i]["params"])){
                if(isset($trace[$i]["args"])){
                    $args = $trace[$i]["args"];
                }else{
                    $args = $trace[$i]["params"];
                }
                foreach($args as $name => $value){
                    $params .= (is_object($value) ? get_class($value) . " " . (method_exists($value, "__toString") ? $value->__toString() : "object") : gettype($value) . " " . (is_array($value) ? "Array()" : Utils::printable(@strval($value)))) . ", ";
                }
            }
            $messages[] = "#$j " . (isset($trace[$i]["file"]) ? cleanPath($trace[$i]["file"]) : "") . "(" . (isset($trace[$i]["line"]) ? $trace[$i]["line"] : "") . "): " . (isset($trace[$i]["class"]) ? $trace[$i]["class"] . (($trace[$i]["type"] === "dynamic" or $trace[$i]["type"] === "->") ? "->" : "::") : "") . $trace[$i]["function"] . "(" . Utils::printable(substr($params, 0, -2)) . ")";
        }

        return $messages;
    }

kill()

if (isset( $opts["enable-profiler"])) pocketmine\kill

(

$pid

)

Parameters

$pid

                       {
        switch(Utils::getOS()){
            case "win":
                exec("taskkill.exe /F /PID " . ((int) $pid) . " > NUL");
                break;
            case "mac":
            case "linux":
            default:
                if(function_exists("posix_kill")){
                    posix_kill($pid, SIGKILL);
                }else{
                    exec("kill -9 " . ((int) $pid) . " > /dev/null 2>&1");
                }
        }
    }

parse_offset()

pocketmine\parse_offset

(

$offset

)

Parameters

string

$offset

In the format of +09:00, +02:00, -04:00 etc.

Returns

string

                                  {
        //Make signed offsets unsigned for date_parse
        if(strpos($offset, '-') !== false){
            $negative_offset = true;
            $offset = str_replace('-', '', $offset);
        }else{
            if(strpos($offset, '+') !== false){
                $negative_offset = false;
                $offset = str_replace('+', '', $offset);
            }else{
                return false;
            }
        }

        $parsed = date_parse($offset);
        $offset = $parsed['hour'] * 3600 + $parsed['minute'] * 60 + $parsed['second'];

        //After date_parse is done, put the sign back
        if($negative_offset == true){
            $offset = -abs($offset);
        }

        //And then, look the offset up.
        //timezone_name_from_abbr is not used because it returns false on some(most) offsets because it's mapping function is weird.
        //That's been a bug in PHP since 2008!
        foreach(timezone_abbreviations_list() as $zones){
            foreach($zones as $timezone){
                if($timezone['offset'] == $offset){
                    return $timezone['timezone_id'];
                }
            }
        }

        return false;
    }

    if(isset($opts["enable-profiler"])){
        if(function_exists("profiler_enable")){
            \profiler_enable();
            $logger->notice("Execution is being profiled");
        }else{
            $logger->notice("No profiler found. Please install https://github.com/krakjoe/profiler");
        }
    }

Variable Documentation

$autoloader

if (version_compare("7.0", PHP_VERSION) > 0) if (!extension_loaded("pthreads")) if (!class_exists("ClassLoader", false)) $autoloader = new \BaseClassLoader()

$erroredThreads

$erroredThreads = 0

$errors

$errors = 0

$killer

$killer = new ServerKiller(8)

$logger

$logger = new MainLogger(\pocketmine\DATA . "server.log", \pocketmine\ANSI)

$opts

$opts = getopt("", ["data:", "plugins:", "no-wizard", "enable-profiler"])

$pthreads_version

if (php_sapi_name() !=="cli") if (!extension_loaded("sockets")) $pthreads_version = phpversion("pthreads")

ANSI

const ANSI Terminal::hasFormattingCodes()

API_VERSION

const API_VERSION = "3.0.1"

CODENAME

const CODENAME = "LlamaSpit"

DATA

const DATA isset($opts["data"]) ? $opts["data"] . DIRECTORY_SEPARATOR : \getcwd() . DIRECTORY_SEPARATOR

else

if ( $erroredThreads > 0) else

Initial value:

{
        @define('pocketmine\PATH', \getcwd() . DIRECTORY_SEPARATOR)

ENDIANNESS

const ENDIANNESS(!defined( 'pocketmine\GIT_COMMIT')) (pack("d", 1) === "\77\360\0\0\0\0\0\0" ? Binary::BIG_ENDIAN : Binary::LITTLE_ENDIAN)

GENISYS_API_VERSION

const GENISYS_API_VERSION = '2.0.0'

INT32_MASK

const INT32_MASK is_int(0xffffffff) ? 0xffffffff : -1

PLUGIN_PATH

const PLUGIN_PATH isset($opts["plugins"]) ? $opts["plugins"] . DIRECTORY_SEPARATOR : \getcwd() . DIRECTORY_SEPARATOR . "plugins" . DIRECTORY_SEPARATOR

START_TIME

const START_TIME microtime(true)

VERSION

const VERSION = "1.1dev"