PHP Class pocketmine\plugin\PluginBase

Inheritance: implements pocketmine\plugin\Plugin
Mostrar archivo Open project: iTXTech/Genisys Class Usage Examples

Public Methods

Method Description
getCommand ( string $name ) : Command | pocketmine\command\PluginIdentifiableCommand
getConfig ( ) : Config
getDataFolder ( )
getDescription ( )
getFullName ( ) : string
getLogger ( ) : PluginLogger
getName ( ) : string
getPluginLoader ( ) : pocketmine\plugin\PluginLoader
getResource ( string $filename ) : resource Gets an embedded resource on the plugin file.
getResources ( ) : string[] Returns all the resources incrusted on the plugin
getServer ( ) : Server
init ( pocketmine\plugin\PluginLoader $loader, Server $server, PluginDescription $description, $dataFolder, $file )
isDisabled ( ) : boolean
isEnabled ( ) : boolean
isInitialized ( ) : boolean
onCommand ( pocketmine\command\CommandSender $sender, Command $command, string $label, array $args ) : boolean
onDisable ( )
onEnable ( )
onLoad ( ) Called when the plugin is loaded, before calling onEnable()
reloadConfig ( )
saveConfig ( )
saveDefaultConfig ( )
saveResource ( string $filename, boolean $replace = false ) : boolean
setEnabled ( boolean $boolean = true )

Protected Methods

Method Description
getFile ( )
isPhar ( ) : boolean

Method Details

getCommand() public method

public getCommand ( string $name ) : Command | pocketmine\command\PluginIdentifiableCommand
$name string
return pocketmine\command\Command | pocketmine\command\PluginIdentifiableCommand

getConfig() public method

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

getDataFolder() final public method

final public getDataFolder ( )

getDescription() final public method

final public getDescription ( )

getFile() protected method

protected getFile ( )

getFullName() final public method

final public getFullName ( ) : string
return string

getLogger() public method

public getLogger ( ) : PluginLogger
return PluginLogger

getName() final public method

final public getName ( ) : string
return string

getPluginLoader() public method

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

getResource() public method

WARNING: You must close the resource given using fclose()
public getResource ( string $filename ) : resource
$filename string
return resource Resource data, or null

getResources() public method

Returns all the resources incrusted on the plugin
public getResources ( ) : string[]
return string[]

getServer() final public method

final public getServer ( ) : Server
return pocketmine\Server

init() final public method

final public init ( pocketmine\plugin\PluginLoader $loader, Server $server, PluginDescription $description, $dataFolder, $file )
$loader pocketmine\plugin\PluginLoader
$server pocketmine\Server
$description PluginDescription

isDisabled() final public method

final public isDisabled ( ) : boolean
return boolean

isEnabled() final public method

final public isEnabled ( ) : boolean
return boolean

isInitialized() final public method

final public isInitialized ( ) : boolean
return boolean

isPhar() protected method

protected isPhar ( ) : boolean
return boolean

onCommand() public method

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

onDisable() public method

public onDisable ( )

onEnable() public method

public onEnable ( )

onLoad() public method

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

reloadConfig() public method

public reloadConfig ( )

saveConfig() public method

public saveConfig ( )

saveDefaultConfig() public method

public saveDefaultConfig ( )

saveResource() public method

public saveResource ( string $filename, boolean $replace = false ) : boolean
$filename string
$replace boolean
return boolean

setEnabled() final public method

final public setEnabled ( boolean $boolean = true )
$boolean boolean