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

Make clear that Plugin->setEnabled() is @internal

Browse Source 
Use of this by plugins will produce a lot of undefined behaviour, such as event handlers not being unregistered, scheduled tasks not being removed, and registered permissions causing memory leaks.
This commit is contained in:
Dylan K. Taylor 2018-10-07 17:48:11 +01:00
parent adbd1c7bed
commit 10fa74b417
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/pocketmine/plugin/Plugin.php
View File

@ -55,6 +55,12 @@ interface Plugin extends CommandExecutor{
public function isEnabled() : bool; public function isEnabled() : bool;
/** /**
* Called by the plugin manager when the plugin is enabled or disabled to inform the plugin of its enabled state.
*
* @internal This is intended for core use only and should not be used by plugins
* @see PluginManager::enablePlugin()
* @see PluginManager::disablePlugin()
*
* @param bool $enabled * @param bool $enabled
*/ */
public function setEnabled(bool $enabled = true) : void; public function setEnabled(bool $enabled = true) : void;

6
src/pocketmine/plugin/PluginBase.php
View File

@ -93,6 +93,12 @@ abstract class PluginBase implements Plugin{
} }
/** /**
* Called by the plugin manager when the plugin is enabled or disabled to inform the plugin of its enabled state.
*
* @internal This is intended for core use only and should not be used by plugins
* @see PluginManager::enablePlugin()
* @see PluginManager::disablePlugin()
*
* @param bool $enabled * @param bool $enabled
*/ */
final public function setEnabled(bool $enabled = true) : void{ final public function setEnabled(bool $enabled = true) : void{