BasePlugin

.Plugins. BasePlugin

一个全局插件只在游戏插件管理器中安装一次. 它可以监听游戏事件并做出响应.

Constructor

new BasePlugin(pluginManager)

Since:
  • 3.8.0
Parameters:
Name Type Description
pluginManager Phaser.Plugins.PluginManager 插件管理器的参考.

Members

(protected) game :Phaser.Game

Since:
  • 3.8.0
这个插件运行的游戏实例的参考.
Type:

(protected) pluginManager :Phaser.Plugins.PluginManager

Since:
  • 3.8.0
负责这个插件的插件管理器的便利参考. 可用作访问游戏系统和事件的途径.
Type:

Methods

destroy()

Since:
  • 3.8.0
游戏实例已被销毁. 你必须释放这里所有的东西,所有的引用,所有的对象,把它们都释放出来.

init(dataopt, nullable)

Since:
  • 3.8.0
插件管理器在一个全局插件第一次实例化时调用这个方法. 它将永远不会在此实例上被再次调用. 在这里你可以设置这个插件运行所需的任何东西. 如果一个插件被设置为自动启动,那么在此之后将立即调用 `BasePlugin.start`. 在一个场景插件中,这个方法是不会被调用的.使用Phaser.Plugins.ScenePlugin#boot.
Parameters:
Name Type Attributes Description
data any <optional>
<nullable>
用户从插件配置对象的 `data` 属性中指定的值(如果在游戏启动时启动),或者在插件管理器的 `install` 方法中传递的值(如果手动启动).

start()

Since:
  • 3.8.0
插件管理器在一个全局插件启动时调用这个方法. 如果一个插件被停止,然后再次启动,这将被再次调用. 通常在 `BasePlugin.init` 之后立即调用. 在一个场景插件中,这个方法是不会被调用的.

stop()

Since:
  • 3.8.0
插件管理器在全局插件停止时调用这个方法. 游戏代码要求你的插件停止做它做的任何事情. 它现在被插件管理器认为是 `inactive` . 在这里处理该过程(即.停止监听事件等) 如果插件再次启动,那么将再次调用 `BasePlugin.start`. 在一个场景插件中,这个方法是不会被调用的.