mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-15 07:55:31 +00:00
Code Issues Projects Releases Wiki Activity

GeneratorManager: add documentation for functions

Browse Source
This commit is contained in:
Dylan K. Taylor 2018-06-07 14:30:19 +01:00
parent 96a4dbb7d8
commit 17b58357fb
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/pocketmine/level/generator/GeneratorManager.php
View File

@ -27,9 +27,12 @@ use pocketmine\level\generator\hell\Nether;
use pocketmine\level\generator\normal\Normal; use pocketmine\level\generator\normal\Normal;
final class GeneratorManager{ final class GeneratorManager{
/** @var string[] name => classname mapping */
private static $list = []; private static $list = [];
/**
* Registers the default known generators.
*/
public static function registerDefaultGenerators() : void{ public static function registerDefaultGenerators() : void{
self::addGenerator(Flat::class, "flat"); self::addGenerator(Flat::class, "flat");
self::addGenerator(Normal::class, "normal"); self::addGenerator(Normal::class, "normal");
@ -38,9 +41,15 @@ final class GeneratorManager{
self::addGenerator(Nether::class, "nether"); self::addGenerator(Nether::class, "nether");
} }
public static function addGenerator(string $object, string $name) : bool{ /**
if(is_subclass_of($object, Generator::class) and !isset(self::$list[$name = strtolower($name)])){ * @param string $class Fully qualified name of class that extends \pocketmine\level\generator\Generator
self::$list[$name] = $object; * @param string $name Alias for this generator type that can be written in configs
*
* @return bool
*/
public static function addGenerator(string $class, string $name) : bool{
if(is_subclass_of($class, Generator::class) and !isset(self::$list[$name = strtolower($name)])){
self::$list[$name] = $class;
return true; return true;
} }
@ -49,6 +58,8 @@ final class GeneratorManager{
} }
/** /**
* Returns a list of names for registered generators.
*
* @return string[] * @return string[]
*/ */
public static function getGeneratorList() : array{ public static function getGeneratorList() : array{
@ -56,6 +67,8 @@ final class GeneratorManager{
} }
/** /**
* Returns a class name of a registered Generator matching the given name.
*
* @param string $name * @param string $name
* *
* @return string|Generator Name of class that extends Generator (not an actual Generator object) * @return string|Generator Name of class that extends Generator (not an actual Generator object)
@ -68,6 +81,13 @@ final class GeneratorManager{
return Normal::class; return Normal::class;
} }
/**
* Returns the registered name of the given Generator class.
*
* @param string $class Fully qualified name of class that extends \pocketmine\level\generator\Generator
*
* @return string
*/
public static function getGeneratorName(string $class) : string{ public static function getGeneratorName(string $class) : string{
foreach(self::$list as $name => $c){ foreach(self::$list as $name => $c){
if($c === $class){ if($c === $class){