### End Setup Wizard Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/dcd/_setup_wizard_8php_source.html Displays completion messages to the user, indicating that the setup wizard has finished and the server is about to start. Includes a brief delay before returning. ```PHP private function endWizard() : void{ $this->message($this->lang->translate(KnownTranslationFactory::you_have_finished())); $this->message($this->lang->translate(KnownTranslationFactory::pocketmine_plugins())); $this->message($this->lang->translate(KnownTranslationFactory::pocketmine_will_start(VersionInfo::NAME))); $this->writeLine(); $this->writeLine(); sleep(4); } ``` -------------------------------- ### PMMP Wizard Classes Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/annotated.html Documentation for the SetupWizard class, used for guiding users through the initial setup process of PocketMine-MP. ```APIDOC SetupWizard: Description: Guides the user through the initial server setup process. ``` -------------------------------- ### Wizard and Setup Classes Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/files.html Classes related to the setup wizard functionality for the project. ```php SetupWizard.php ``` -------------------------------- ### PMMP API: get() Methods Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/functions_func_g.html Documents various 'get' methods across different PMMP classes, including effect managers, error type mappings, NBT lists, binary streams, and tree factories. ```APIDOC get(): pocketmine\entity\effect\EffectManager - Retrieves the EffectManager. get(): pocketmine\errorhandler\ErrorTypeToStringMap - Gets the ErrorTypeToStringMap instance. get(): pocketmine\nbt\tag\ListTag - Retrieves a ListTag. get(): pocketmine\utils\BinaryStream - Reads from a BinaryStream. get(): pocketmine\world\generator\object\TreeFactory - Gets the TreeFactory instance. ``` -------------------------------- ### PMMP API: get() Methods Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/functions_g.html Documents various 'get' methods across different PMMP classes, including effect managers, error type mappings, NBT lists, binary streams, and tree factories. ```APIDOC get(): pocketmine\entity\effect\EffectManager - Retrieves the EffectManager. get(): pocketmine\errorhandler\ErrorTypeToStringMap - Gets the ErrorTypeToStringMap instance. get(): pocketmine\nbt\tag\ListTag - Retrieves a ListTag. get(): pocketmine\utils\BinaryStream - Reads from a BinaryStream. get(): pocketmine\world\generator\object\TreeFactory - Gets the TreeFactory instance. ``` -------------------------------- ### Get SubChunk Example Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d1/db1/_chunk_8php_source.html Example of retrieving a sub-chunk by its Y coordinate. ```PHP public function getSubChunk(int $y) : SubChunk{ if($y < self::MIN_SUBCHUNK_INDEX || $y > self::MAX_SUBCHUNK_INDEX){ throw new InvalidArgumentException("Invalid subchunk Y coordinate $y"); } return $this->subChunks[$y - self::MIN_SUBCHUNK_INDEX]; } ``` -------------------------------- ### Welcome and Initial Messages Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/dcd/_setup_wizard_8php_source.html Displays welcome messages and information about server setup and default values. ```PHP private function welcome() : void{ $this->message($this->lang->translate(KnownTranslationFactory::setting_up_server_now())); $this->message($this->lang->translate(KnownTranslationFactory::default_values_info())); $this->message($this->lang->translate(KnownTranslationFactory::server_properties())); } ``` -------------------------------- ### Get All SubChunks Example Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d1/db1/_chunk_8php_source.html Example of retrieving all sub-chunks within the chunk. ```PHP public function getSubChunks() : array{ $result = []; foreach($this->subChunks as $yOffset => $subChunk){ $result[$yOffset + self::MIN_SUBCHUNK_INDEX] = $subChunk; } return $result; } ``` -------------------------------- ### Server Setup Wizard Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/dcd/_setup_wizard_8php_source.html Handles the initial setup of a PocketMine-MP server, including language selection, license agreement, and basic configuration generation. It prompts the user for various settings and saves them to server.properties. ```PHP private function setupWizard() : bool{ // ... (code for language selection, license check, welcome message) ... // Configuration generation $config = new Config(Path::join($this->dataPath, "server.properties"), Config::PROPERTIES); $config->set(ServerProperties::LANGUAGE, $lang); $config->save(); // ... (code for skipping installer, generating base config, user files, network functions) ... return true; } ``` -------------------------------- ### SetupWizard Class API Documentation Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d7/dde/classpocketmine_1_1wizard_1_1_setup_wizard.html Provides detailed API documentation for the SetupWizard class, including its constructor, methods, and attributes. This class is responsible for setting up the PocketMine-MP server wizard. ```APIDOC __construct(private string $dataPath) Initializes the SetupWizard with the server's data path. Definition at line 60 of SetupWizard.php. run() Executes the setup wizard process. Definition at line 64 of SetupWizard.php. DEFAULT_NAME = Server::DEFAULT_SERVER_NAME Deprecated constant for the default server name. Definition at line 52 of SetupWizard.php. DEFAULT_PLAYERS = Server::DEFAULT_MAX_PLAYERS Deprecated constant for the default maximum players. Definition at line 56 of SetupWizard.php. DEFAULT_PORT = Server::DEFAULT_PORT_IPV4 Deprecated constant for the default server port. Definition at line 54 of SetupWizard.php. ``` -------------------------------- ### PocketMine Server: Get Start Time Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d5/df7/classpocketmine_1_1_server.html Retrieves the timestamp when the server was started. ```APIDOC pocketmine\Server::getStartTime() Definition at line 488 of file src/Server.php. ``` -------------------------------- ### Get Server Start Time Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d0/d05/src_2_server_8php_source.html Retrieves the timestamp when the server was started. ```PHP public function getStartTime() : float ``` -------------------------------- ### PocketMine-MP SetupWizard.php Reference Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/dir_e09032bb770e6e0f4355f890c3180c4a.html Reference to the SetupWizard.php file within the wizard directory of PocketMine-MP. This file is part of the project's source code. ```APIDOC SetupWizard.php - Located in the 'wizard' directory. - Part of the PocketMine-MP project. ``` -------------------------------- ### Doxygen Initialization Scripts Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html JavaScript snippets for initializing Doxygen-generated documentation, including search box functionality, code folding, and navigation tree setup. ```javascript var searchBox = new SearchBox("searchBox", "search/",".html"); $(function() { codefold.init(0); }); $(function() { initMenu('',true,false,'search.php','Search',true); $(function() { init_search(); }); }); $(function(){initNavTree('dir_68267d1309a1af8e8297ef4c3efbcdba.html',''); initResizable(true); }); ``` -------------------------------- ### Get All Terrain Dirty Flags Example Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d1/db1/_chunk_8php_source.html Example of retrieving all terrain dirty flags. ```PHP public function getTerrainDirtyFlags() : int{ return $this->terrainDirtyFlags; } ``` -------------------------------- ### License Display and Acceptance Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/dcd/_setup_wizard_8php_source.html Displays the GNU Lesser General Public License and prompts the user to accept it. If the license is not accepted, the setup process is halted. ```PHP private function showLicense() : bool{ $this->message($this->lang->translate(KnownTranslationFactory::welcome_to_pocketmine(VersionInfo::NAME))); echo <<writeLine(); if(strtolower($this->getInput($this->lang->translate(KnownTranslationFactory::accept_license()), "n", "y/N")) !== "y"){ $this->error($this->lang->translate(KnownTranslationFactory::you_have_to_accept_the_license(VersionInfo::NAME))); sleep(5); return false; } return true; } ``` -------------------------------- ### Get Height Map Array Example Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d1/db1/_chunk_8php_source.html Example of retrieving the height map array from a chunk. ```PHP public function getHeightMapArray() : array{ return $this->heightMap->getValues(); } ``` -------------------------------- ### Get Specific Terrain Dirty Flag Example Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d1/db1/_chunk_8php_source.html Example of checking a specific terrain dirty flag. ```PHP public function getTerrainDirtyFlag(int $flag) : bool{ return ($this->terrainDirtyFlags & $flag) !== 0; } ``` -------------------------------- ### TimingsHandler: Get Start Time Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/df7/_timings_handler_8php_source.html Retrieves the timestamp when the current timing period started. This is useful for calculating the duration of performance monitoring sessions. ```APIDOC getStartTime(): float Returns the start time of the current timing period. The time is represented as a high-resolution timestamp. ``` -------------------------------- ### PocketMine-MP SetupWizard Class Source: https://github.com/pmmp/apidoc.pmmp.io/blob/master/docs/d3/dcd/_setup_wizard_8php_source.html Defines the SetupWizard class for PocketMine-MP, including constants for default server settings and methods for running the setup process. It handles language selection and basic server configuration. ```PHP