112 lines
2.3 KiB
PHP

<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
/**
* Plugin related classes
*/
namespace pocketmine\plugin;
use pocketmine\command\CommandExecutor;
/**
* It is recommended to use PluginBase for the actual plugin
*
*/
interface Plugin extends CommandExecutor{
/**
* Called when the plugin is loaded, before calling onEnable()
*/
public function onLoad();
/**
* Called when the plugin is enabled
*/
public function onEnable();
public function isEnabled();
/**
* Called when the plugin is disabled
* Use this to free open things and finish actions
*/
public function onDisable();
public function isDisabled();
/**
* Gets the plugin's data folder to save files and configuration
*/
public function getDataFolder();
/**
* @return PluginDescription
*/
public function getDescription();
/**
* Gets an embedded resource in the plugin file.
*/
public function getResource($filename);
/**
* Saves an embedded resource to its relative location in the data folder
*
* @param string $filename
* @param bool $replace
*/
public function saveResource($filename, $replace = false);
/**
* Returns all the resources incrusted in the plugin
*/
public function getResources();
/**
* @return \pocketmine\utils\Config
*/
public function getConfig();
public function saveConfig();
public function saveDefaultConfig();
public function reloadConfig();
/**
* @return \pocketmine\Server
*/
public function getServer();
public function getName();
/**
* @return PluginLogger
*/
public function getLogger();
/**
* @return PluginLoader
*/
public function getPluginLoader();
}