controller# ULive2dController

用于整合 stage, model 等其他控制器, 并否则插件的安装与卸载等等

Constructor

new ULive2dController(options)

live2d 控制器

创建 live2d 控制器

Parameters:
NameTypeDescription
optionsDLive2dOptions

Live2d 数据

Throws:

PIXI.Application is null

Type
Error

Members

(protected) _app :TApplication

app 实例

PIXI.Application 实例

(protected) _data :DLive2dOptions

Live2d数据

Live2d 数据集合, 用于存储 live2d 对应的数据

(protected) _event :EventEmitter

event 实例

EventEmitter3 实例, 更多请查看 EventEmitter3

Type:
  • EventEmitter

(protected) _model :UModelController

model 控制器

用于控制模型相关的的控制器

(protected) _plugins :Array.<FBasePlugin>

插件集

负责存储所有插件实例的数组

Type:

(protected) _ref :Record.<string, any>

对象引用

以键值对进行记录的对象引用

Type:
  • Record.<string, any>

(protected) _stage :UStageController

stage 控制器

用于控制 stage 相关的的控制器

(protected) _tips :UTipsController

tips 控制器

用于控制 tips 相关的的控制器

(readonly) app :TApplication

app 实例

getter: Application 实例

(readonly) data :DLive2dOptions

live2d 数据

getter: live2d 原始数据

(readonly) event :EventEmitter

event 实例

getter: EventEmitter3 实例

Type:
  • EventEmitter

(readonly) model :UModelController

model 控制器

getter: 获取 model 控制器实例

(readonly) plugins :Array.<FBasePlugin>

插件集

getter: 获取所有插件实例数组

Type:

(readonly) ref :Record.<string, any>

对象引用

getter: 以键值对进行记录的对象引用

Type:
  • Record.<string, any>

(readonly) stage :UStageController

stage 控制器

getter: 获取 stage 控制器实例

(readonly) tips :UTipsController

tips 控制器

getter: 获取 tips 控制器实例

Methods

destroy(removeViewopt)

销毁控制器

卸载插件, 销毁控制器, 销毁 app 实例

Parameters:
NameTypeAttributesDefaultDescription
removeViewboolean<optional>
false

从 DOM 中移除 Canvas 元素

Fires:
  • EEvent#event:destroy 控制器销毁事件

init()

初始化控制器

开始安装插件并进行 live2d 控制器初始化

Fires:
  • EEvent#event:init 控制器初始化事件

installPlugin(…plugins)

安装插件

如果 plugin 不是 FBasePlugin 的子类则不会进行安, 否则根据插件的优先级进行安装

Parameters:
NameTypeAttributesDescription
pluginsExtract.<T, FBasePlugin><repeatable>

插件实例集

uninstallPlugin(…plugins)

卸载插件

从插件集中卸载指定的插件

Parameters:
NameTypeAttributesDescription
pluginsExtract.<T, FBasePlugin><repeatable>

插件实例集

(static) create(optionsopt) → {ULive2dController}

创建 live2d 实例

传递 options 数据, 并创建一个 live2d 实例

Parameters:
NameTypeAttributesDefaultDescription
optionsDLive2dOptions | null<optional>
null

live2d 选项

Returns:

live2d 实例

Type: 
ULive2dController