GarbageCollectorCommand Class Reference

Public Member Functions
	__construct ($name)
	execute (CommandSender $sender, $currentAlias, array $args)
Public Member Functions inherited from VanillaCommand
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
Public Member Functions inherited from Command
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
	getDefaultCommandData ()
	generateCustomCommandData (Player $player)
	getOverloads ()
	execute (CommandSender $sender, $commandLabel, array $args)
	getName ()
	getPermission ()
	setPermission ($permission)
	testPermission (CommandSender $target)
	testPermissionSilent (CommandSender $target)
	getLabel ()
	setLabel ($name)
	register (CommandMap $commandMap)
	unregister (CommandMap $commandMap)
	isRegistered ()
	getAliases ()
	getPermissionMessage ()
	getDescription ()
	getUsage ()
	setAliases (array $aliases)
	setDescription ($description)
	setPermissionMessage ($permissionMessage)
	setUsage ($usage)
	__toString ()

Additional Inherited Members
Static Public Member Functions inherited from Command
static	generateDefaultData ()
static	broadcastCommandMessage (CommandSender $source, $message, $sendToSource=true)
Data Fields inherited from VanillaCommand
const	MAX_COORD = 30000000
const	MIN_COORD = -30000000
Data Fields inherited from Command
	$timings
Protected Member Functions inherited from VanillaCommand
	getInteger (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getRelativeDouble ($original, CommandSender $sender, $input, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getDouble (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
Protected Attributes inherited from Command
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

__construct

(

$name

)

GarbageCollectorCommand constructor.

Parameters

$name

                                      {
        parent::__construct(
            $name,
            "%pocketmine.command.gc.description",
            "%pocketmine.command.gc.usage"
        );
        $this->setPermission("pocketmine.command.gc");
    }

Member Function Documentation

execute()

execute	(	CommandSender	$sender,
			$currentAlias,
		array	$args
	)

Parameters

CommandSender	$sender
string	$currentAlias
array	$args

Returns

bool

                                                                              {
        if(!$this->testPermission($sender)){
            return true;
        }

        $chunksCollected = 0;
        $entitiesCollected = 0;
        $tilesCollected = 0;

        $memory = memory_get_usage();

        foreach($sender->getServer()->getLevels() as $level){
            $diff = [count($level->getChunks()), count($level->getEntities()), count($level->getTiles())];
            $level->doChunkGarbageCollection();
            $level->unloadChunks(true);
            $chunksCollected += $diff[0] - count($level->getChunks());
            $entitiesCollected += $diff[1] - count($level->getEntities());
            $tilesCollected += $diff[2] - count($level->getTiles());
            $level->clearCache(true);
        }

        $cyclesCollected = $sender->getServer()->getMemoryManager()->triggerGarbageCollector();
        $sender->sendMessage(TextFormat::GREEN . "---- " . TextFormat::WHITE . "%pocketmine.command.gc.title" . TextFormat::GREEN . " ----");
        $sender->sendMessage(TextFormat::GOLD . "%pocketmine.command.gc.chunks" . TextFormat::RED . \number_format($chunksCollected));
        $sender->sendMessage(TextFormat::GOLD . "%pocketmine.command.gc.entities" . TextFormat::RED . \number_format($entitiesCollected));
        $sender->sendMessage(TextFormat::GOLD . "%pocketmine.command.gc.tiles" . TextFormat::RED . \number_format($tilesCollected));
        $sender->sendMessage(TextFormat::GOLD . "%pocketmine.command.gc.cycles" . TextFormat::RED . \number_format($cyclesCollected));
        $sender->sendMessage(TextFormat::GOLD . "%pocketmine.command.gc.memory" . TextFormat::RED . \number_format(\round((($memory - \memory_get_usage()) / 1024) / 1024, 2)) . " MB");
        return true;
    }

---

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

• src/pocketmine/command/defaults/GarbageCollectorCommand.php