PluginBase

abstract class · pocketmine\plugin\PluginBase · source

Implements Plugin, CommandExecutor

Methods

__construct()

public function __construct(\pocketmine\plugin\PluginLoader $loader, \pocketmine\Server $server, \pocketmine\plugin\PluginDescription $description, string $dataFolder, string $file, \pocketmine\plugin\ResourceProvider $resourceProvider)

getCommand()

public function getCommand(string $name)

getConfig()

public function getConfig() : \pocketmine\utils\Config

getDataFolder()

final public function getDataFolder() : string

getDescription()

final public function getDescription() : \pocketmine\plugin\PluginDescription

getFile() protected

protected function getFile() : string

getFullName()

final public function getFullName() : string

getLogger()

public function getLogger() : \AttachableLogger

getName()

final public function getName() : string

getPluginLoader()

public function getPluginLoader() : \pocketmine\plugin\PluginLoader

getResource()

public function getResource(string $filename)

Deprecated

Prefer using standard PHP functions with PluginBase::getResourcePath(), like

Gets an embedded resource on the plugin file. WARNING: You must close the resource given using fclose()

getResourceFolder()

public function getResourceFolder() : string

Returns the path to the folder where the plugin's embedded resource files are usually located. Note: This is NOT the same as the data folder. The files in this folder should be considered read-only.

getResourcePath()

public function getResourcePath(string $filename) : string

Returns the full path to a data file in the plugin's resources folder. This path can be used with standard PHP functions like fopen() or file_get_contents().

Note: Any path returned by this function should be considered READ-ONLY.

getResources()

public function getResources() : array

Returns all the resources packaged with the plugin in the form ["path/in/resources" => SplFileInfo]

getScheduler()

public function getScheduler() : \pocketmine\scheduler\TaskScheduler

getServer()

final public function getServer() : \pocketmine\Server

isDisabled()

final public function isDisabled() : bool

isEnabled()

final public function isEnabled() : bool

onCommand()

public function onCommand(\pocketmine\command\CommandSender $sender, \pocketmine\command\Command $command, string $label, array $args) : bool

onDisable() protected

protected function onDisable() : void

Called when the plugin is disabled Use this to free open things and finish actions

onEnable() protected

protected function onEnable() : void

Called when the plugin is enabled

onLoad() protected

protected function onLoad() : void

Called when the plugin is loaded, before calling onEnable()

reloadConfig()

public function reloadConfig() : void

saveConfig()

public function saveConfig() : void

saveDefaultConfig()

public function saveDefaultConfig() : bool

saveResource()

public function saveResource(string $filename, bool $replace = false) : bool

Saves an embedded resource to its relative location in the data folder