Plugin Interface Reference

Inheritance diagram for Plugin:

Public Member Functions
	onLoad ()
	onEnable ()
	isEnabled ()
	onDisable ()
	isDisabled ()
	getDataFolder ()
	getDescription ()
	getResource ($filename)
	saveResource ($filename, $replace=false)
	getResources ()
	getConfig ()
	saveConfig ()
	saveDefaultConfig ()
	reloadConfig ()
	getServer ()
	getName ()
	getLogger ()
	getPluginLoader ()
Public Member Functions inherited from CommandExecutor
	onCommand (CommandSender $sender, Command $command, $label, array $args)

Detailed Description

It is recommended to use PluginBase for the actual plugin

Member Function Documentation

getConfig

(

)

Returns

Implemented in PluginBase.

getDataFolder

(

)

Gets the plugin's data folder to save files and configuration. This directory name has a trailing slash.

Implemented in PluginBase.

getDescription

(

)

Returns

PluginDescription

Implemented in PluginBase.

getLogger

(

)

Returns

PluginLogger

Implemented in PluginBase.

getPluginLoader

(

)

Returns

PluginLoader

Implemented in PluginBase.

getResource

(

$filename

)

Gets an embedded resource in the plugin file.

Parameters

string

$filename

Implemented in PluginBase.

getResources

(

)

Returns all the resources incrusted in the plugin

Implemented in PluginBase.

getServer

(

)

Returns

Implemented in PluginBase.

onDisable

(

)

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

Implemented in PluginBase.

onEnable

(

)

Called when the plugin is enabled

Implemented in PluginBase.

onLoad

(

)

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

Implemented in PluginBase.

saveResource	(		$filename,
			$replace = false
	)

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

Parameters

string	$filename
bool	$replace

Implemented in PluginBase.

---

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

• /Users/Kids/Desktop/Doxygen/pocketmine/plugin/Plugin.php