Skip to content

Latest commit

 

History

History
240 lines (240 loc) · 12.2 KB

cn.nukkit.plugin.PluginBase.md

File metadata and controls

240 lines (240 loc) · 12.2 KB

    • 构造函数一览

      构造函数 
      构造函数描述
      PluginBase() 

    • 成员函数一览

      All Methods Instance Methods Concrete Methods 
      修饰符和类 成员函数描述
      PluginIdentifiableCommand getCommand(String name)
      TODO: FINISH JAVADOC
      Config getConfig()
      返回这个Nukkit插件配置文件的Config对象。
      The config file this Nukkit plugin as a Config object.
      File getDataFolder()
      返回这个Nukkit插件的数据文件夹。
      The data folder of this Nukkit plugin.
      PluginDescription getDescription()
      返回描述这个Nukkit插件的PluginDescription对象。
      The description this Nukkit plugin as a PluginDescription object.
      protected File getFile()
      返回这个插件的文件File对象。对于jar格式的插件，就是jar文件本身。
      Returns the File object of this plugin itself.
      String getFullName()
      返回这个插件完整的名字。
      Returns the full name of this plugin.
      PluginLogger getLogger()
      返回这个插件的日志记录器为PluginLogger对象。
      Returns the logger of this plugin as a PluginLogger object.
      String getName()
      返回这个插件的名字。
      Returns the name of this plugin.
      PluginLoader getPluginLoader()
      返回这个插件的加载器为PluginLoader对象。
      Returns the loader of this plugin as a PluginLoader object.
      InputStream getResource(String filename)
      读取这个插件特定的资源文件，并返回为InputStream对象。
      Reads a resource of this plugin, and returns as an InputStream object.
      Server getServer()
      返回运行这个插件的服务器的Server对象。
      Gets the server which is running this plugin, and returns as a Server object.
      void init(PluginLoader loader, Server server, PluginDescription description, File dataFolder, File file)
      初始化这个插件。
      Initialize the plugin.
      boolean isDisabled()
      返回这个Nukkit插件是否已停用。
      Whether this Nukkit plugin is disabled.
      boolean isEnabled()
      返回这个Nukkit插件是否已启用。
      Whether this Nukkit plugin is enabled.
      boolean isInitialized()
      返回这个插件是否已经初始化。
      Returns if this plugin is initialized.
      boolean onCommand(CommandSender sender, Command command, String label, String[] args)
      在命令执行时会调用的方法。
      Called when a command is executed.
      void onDisable()
      在一个Nukkit插件被停用时调用的方法。
      Called when a Nukkit plugin is disabled.
      void onEnable()
      在一个Nukkit插件被启用时调用的方法。
      Called when a Nukkit plugin is enabled.
      void onLoad()
      在一个Nukkit插件被加载时调用的方法。这个方法会在Plugin.onEnable()之前调用。
      Called when a Nukkit plugin is loaded, before Plugin.onEnable() .
      void reloadConfig()
      重新读取这个Nukkit插件的默认配置文件。
      Reloads the plugin config.
      void saveConfig()
      保存这个Nukkit插件的配置文件。
      Saves the plugin config.
      void saveDefaultConfig()
      保存这个Nukkit插件的默认配置文件。
      Saves the DEFAULT plugin config.
      boolean saveResource(String filename)
      保存这个Nukkit插件的资源。
      Saves the resource of this plugin.
      boolean saveResource(String filename, boolean replace)
      保存或替换这个Nukkit插件的资源。
      Saves or replaces the resource of this plugin.
      boolean saveResource(String filename, String outputName, boolean replace) 
      void setEnabled()
      加载这个插件。
      Enables this plugin.
      void setEnabled(boolean value)
      加载或卸载这个插件。
      Enables or disables this plugin.

      • 继承自类 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait