QueryRegenerateEvent Class Reference

Public Member Functions
	__construct (Server $server, $timeout=5)
	getTimeout ()
	setTimeout ($timeout)
	getServerName ()
	setServerName ($serverName)
	canListPlugins ()
	setListPlugins ($value)
	getPlugins ()
	setPlugins (array $plugins)
	getPlayerList ()
	setPlayerList (array $players)
	getPlayerCount ()
	setPlayerCount ($count)
	getMaxPlayerCount ()
	setMaxPlayerCount ($count)
	getWorld ()
	setWorld ($world)
	getExtraData ()
	setExtraData (array $extraData)
	getLongQuery ()
	getShortQuery ()
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()

Data Fields
const	GAME_ID = "MINECRAFTPE"

Static Public Attributes
static	$handlerList = null

Additional Inherited Members
Protected Attributes inherited from Event
	$eventName = null

Constructor & Destructor Documentation

__construct()

__construct	(	Server	$server,
			$timeout = 5
	)

QueryRegenerateEvent constructor.

Parameters

Server	$server
int	$timeout

                                                             {
        $this->timeout = $timeout;
        $this->serverName = $server->getMotd();
        $this->listPlugins = $server->getProperty("settings.query-plugins", true);
        $this->plugins = $server->getPluginManager()->getPlugins();
        $this->players = [];
        foreach($server->getOnlinePlayers() as $player){
            if($player->isOnline()){
                $this->players[] = $player;
            }
        }

        if($server->isDServerEnabled() and $server->dserverConfig["queryMaxPlayers"]) $pc = $server->dserverConfig["queryMaxPlayers"];
        elseif($server->isDServerEnabled() and $server->dserverConfig["queryAllPlayers"]) $pc = $server->getDServerMaxPlayers();
        else $pc = $server->getMaxPlayers();

        if($server->isDServerEnabled() and $server->dserverConfig["queryPlayers"]) $poc = $server->getDServerOnlinePlayers();
        else $poc = count($this->players);

        $this->gametype = ($server->getGamemode() & 0x01) === 0 ? "SMP" : "CMP";
        $this->version = $server->getVersion();
        $this->server_engine = $server->getName() . " " . $server->getPocketMineVersion();
        $this->map = $server->getDefaultLevel() === null ? "unknown" : $server->getDefaultLevel()->getName();
        $this->numPlayers = $poc;
        $this->maxPlayers = $pc;
        $this->whitelist = $server->hasWhitelist() ? "on" : "off";
        $this->port = $server->getPort();
        $this->ip = $server->getIp();

    }

Member Function Documentation

canListPlugins()

canListPlugins

(

)

Returns

mixed

                                    {
        return $this->listPlugins;
    }

getExtraData()

getExtraData

(

)

Returns the extra Query data in key => value form

Returns

array

                                  {
        return $this->extraData;
    }

getLongQuery()

getLongQuery

(

)

Returns

string

                                  {
        $query = "";

        $plist = $this->server_engine;
        if(count($this->plugins) > 0 and $this->listPlugins){
            $plist .= ":";
            foreach($this->plugins as $p){
                $d = $p->getDescription();
                $plist .= " " . str_replace([";", ":", " "], ["", "", "_"], $d->getName()) . " " . str_replace([";", ":", " "], ["", "", "_"], $d->getVersion()) . ";";
            }
            $plist = substr($plist, 0, -1);
        }

        $KVdata = [
            "splitnum" => chr(128),
            "hostname" => $this->serverName,
            "gametype" => $this->gametype,
            "game_id" => self::GAME_ID,
            "version" => $this->version,
            "server_engine" => $this->server_engine,
            "plugins" => $plist,
            "map" => $this->map,
            "numplayers" => $this->numPlayers,
            "maxplayers" => $this->maxPlayers,
            "whitelist" => $this->whitelist,
            "hostip" => $this->ip,
            "hostport" => $this->port
        ];

        foreach($KVdata as $key => $value){
            $query .= $key . "\x00" . $value . "\x00";
        }

        foreach($this->extraData as $key => $value){
            $query .= $key . "\x00" . $value . "\x00";
        }

        $query .= "\x00\x01player_\x00\x00";
        foreach($this->players as $player){
            $query .= $player->getName() . "\x00";
        }
        $query .= "\x00";

        return $query;
    }

getMaxPlayerCount()

getMaxPlayerCount

(

)

Returns

int

                                       {
        return $this->maxPlayers;
    }

getPlayerCount()

getPlayerCount

(

)

Returns

int

                                    {
        return $this->numPlayers;
    }

getPlayerList()

getPlayerList

(

)

Returns

[]

                                   {
        return $this->players;
    }

getPlugins()

getPlugins

(

)

Returns

[]

                                {
        return $this->plugins;
    }

getServerName()

getServerName

(

)

Returns

string

                                   {
        return $this->serverName;
    }

getShortQuery()

getShortQuery

(

)

Returns

string

                                   {
        return $this->serverName . "\x00" . $this->gametype . "\x00" . $this->map . "\x00" . $this->numPlayers . "\x00" . $this->maxPlayers . "\x00" . Binary::writeLShort($this->port) . $this->ip . "\x00";
    }

getTimeout()

getTimeout

(

)

Gets the min. timeout for Query Regeneration

Returns

int

                                {
        return $this->timeout;
    }

getWorld()

getWorld

(

)

Returns

string

                              {
        return $this->map;
    }

setExtraData()

setExtraData

(

array

$extraData

)

Parameters

array

$extraData

                                                  {
        $this->extraData = $extraData;
    }

setListPlugins()

setListPlugins

(

$value

)

Parameters

$value

                                          {
        $this->listPlugins = (bool) $value;
    }

setMaxPlayerCount()

setMaxPlayerCount

(

$count

)

Parameters

$count

                                             {
        $this->maxPlayers = (int) $count;
    }

setPlayerCount()

setPlayerCount

(

$count

)

Parameters

$count

                                          {
        $this->numPlayers = (int) $count;
    }

setPlayerList()

setPlayerList

(

array

$players

)

Parameters

                                                 {
        $this->players = $players;
    }

setPlugins()

setPlugins

(

array

$plugins

)

Parameters

                                              {
        $this->plugins = $plugins;
    }

setServerName()

setServerName

(

$serverName

)

Parameters

$serverName

                                              {
        $this->serverName = $serverName;
    }

setTimeout()

setTimeout

(

$timeout

)

Parameters

$timeout

                                        {
        $this->timeout = $timeout;
    }

setWorld()

setWorld

(

$world

)

Parameters

$world

                                    {
        $this->map = (string) $world;
    }

Field Documentation

$handlerList

$handlerList = null

static

GAME_ID

const GAME_ID = "MINECRAFTPE"

---

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

• src/pocketmine/event/server/QueryRegenerateEvent.php