plugins FBasePlugin

live2d 基础插件, 所有插件都需要从此类继承

Members

(protected) _enable :boolean

启用插件

true: 启用插件, false: 不启用插件

Type:
  • boolean
Default Value
  • true

(protected) _live2d :ULive2dController

live2d 上下文

插件 live2d 上下文, 用于获取对应的数据

(protected) _name :string

插件名称

插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装

Type:
  • string
Default Value
  • ''

(protected) _priority :number

优先级

插件优先级, 在安装插件是会按照优先级依次执行

Type:
  • number
Default Value
  • 0

(readonly) name :string

创建名称

插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装

Type:
  • string

(readonly) priority :number

优先级

插件优先级, 在安装插件是会按照优先级依次执行

Type:
  • number

Methods

(abstract) install(live2d) → {void}

安装插件

在安装插件时需要调用的函数, 一般用于初始化以及事件绑定等等

Parameters:
NameTypeDescription
live2dULive2dController

live2d 上下文

Returns:
Type: 
void

isEnable() → {boolean}

是否启用插件

根据相关条件判断插件是否启用

Returns:

true: 启用

Type: 
boolean

(abstract) uninstall(live2d) → {void}

卸载插件

在卸载插件时需要调用的函数, 一般用于销毁数据以及事件解绑等等

Parameters:
NameTypeDescription
live2dULive2dController

live2d 上下文

Returns:
Type: 
void