Plugin Interface Reference

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()

getConfig

(

)

Returns

Implemented in PluginBase.

getDataFolder()

getDataFolder

(

)

Gets the plugin's data folder to save files and configuration

Implemented in PluginBase.

getDescription()

getDescription

(

)

Returns

PluginDescription

Implemented in PluginBase.

getLogger()

getLogger

(

)

Returns

PluginLogger

Implemented in PluginBase.

getName()

getName

(

)

Returns

mixed

Implemented in PluginBase.

getPluginLoader()

getPluginLoader

(

)

Returns

PluginLoader

Implemented in PluginBase.

getResource()

getResource

(

$filename

)

Gets an embedded resource in the plugin file.

Parameters

string

$filename

Implemented in PluginBase.

getResources()

getResources

(

)

Returns all the resources packaged with the plugin

Implemented in PluginBase.

getServer()

getServer

(

)

Returns

Implemented in PluginBase.

isDisabled()

isDisabled

(

)

Returns

mixed

Implemented in PluginBase.

isEnabled()

isEnabled

(

)

Returns

mixed

Implemented in PluginBase.

onDisable()

onDisable

(

)

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

Implemented in PluginBase.

onEnable()

onEnable

(

)

Called when the plugin is enabled

Implemented in PluginBase.

onLoad()

onLoad

(

)

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

Implemented in PluginBase.

reloadConfig()

reloadConfig

(

)

Returns

mixed

Implemented in PluginBase.

saveConfig()

saveConfig

(

)

Returns

mixed

Implemented in PluginBase.

saveDefaultConfig()

saveDefaultConfig

(

)

Returns

mixed

Implemented in PluginBase.

saveResource()

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:

• src/pocketmine/plugin/Plugin.php