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

Relocate a couple of Entity API methods and add some documentation

Browse Source
This commit is contained in:
Dylan K. Taylor 2017-10-19 16:59:44 +01:00
parent d99e9513b0
commit 67c6fca0ed
1 changed files with 54 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
src/pocketmine/entity/Entity.php
View File

@ -219,7 +219,10 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
/** @var string[] */ /** @var string[] */
private static $shortNames = []; private static $shortNames = [];
public static function init(){ /**
* Called on server startup to register default entity types.
*/
public static function init() : void{
Entity::registerEntity(Arrow::class); Entity::registerEntity(Arrow::class);
Entity::registerEntity(Egg::class); Entity::registerEntity(Egg::class);
Entity::registerEntity(FallingSand::class); Entity::registerEntity(FallingSand::class);
@ -233,6 +236,56 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
Entity::registerEntity(Human::class, true); Entity::registerEntity(Human::class, true);
} }
/**
* Creates an entity with the specified type, level and NBT, with optional additional arguments to pass to the
* entity's constructor
*
* @param int|string $type
* @param Level $level
* @param CompoundTag $nbt
* @param mixed ...$args
*
* @return Entity|null
*/
public static function createEntity($type, Level $level, CompoundTag $nbt, ...$args) : ?Entity{
if(isset(self::$knownEntities[$type])){
$class = self::$knownEntities[$type];
return new $class($level, $nbt, ...$args);
}
return null;
}
/**
* Registers an entity type into the index.
*
* @param string $className Class that extends Entity
* @param bool $force Force registration even if the entity does not have a valid network ID
*
* @return bool
*/
public static function registerEntity(string $className, bool $force = false) : bool{
assert(is_a($className, Entity::class, true));
/** @var Entity $className */
$class = new \ReflectionClass($className);
if(is_a($className, Entity::class, true) and !$class->isAbstract()){
if($className::NETWORK_ID !== -1){
self::$knownEntities[$className::NETWORK_ID] = $className;
}elseif(!$force){
return false;
}
self::$knownEntities[$class->getShortName()] = $className;
self::$shortNames[$className] = $class->getShortName();
return true;
}
return false;
}
/** /**
* @var Player[] * @var Player[]
*/ */
@ -682,40 +735,6 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
} }
} }
/**
* @param int|string $type
* @param Level $level
* @param CompoundTag $nbt
* @param $args
*
* @return Entity|null
*/
public static function createEntity($type, Level $level, CompoundTag $nbt, ...$args){
if(isset(self::$knownEntities[$type])){
$class = self::$knownEntities[$type];
return new $class($level, $nbt, ...$args);
}
return null;
}
public static function registerEntity($className, bool $force = false) : bool{
$class = new \ReflectionClass($className);
if(is_a($className, Entity::class, true) and !$class->isAbstract()){
if($className::NETWORK_ID !== -1){
self::$knownEntities[$className::NETWORK_ID] = $className;
}elseif(!$force){
return false;
}
self::$knownEntities[$class->getShortName()] = $className;
self::$shortNames[$className] = $class->getShortName();
return true;
}
return false;
}
/** /**
* Returns whether this entity will be saved when its chunk is unloaded. * Returns whether this entity will be saved when its chunk is unloaded.
* @return bool * @return bool