- Source
Extends
Members
(protected) _button :HTMLElement
切换按钮
用于切换的按钮元素
Type:
- HTMLElement
- Inherited From
- Source
(protected) _enable :boolean
启用插件
true: 启用插件, false: 不启用插件
Type:
- boolean
- Inherited From
- Default Value
- true
- Source
(protected) _live2d :ULive2dController
live2d 上下文
插件 live2d 上下文, 用于获取对应的数据
Type:
- Inherited From
- Source
(protected) _loading :HTMLElement
加载中
用于切换模型后显示是否还在加载中的加载元素
Type:
- HTMLElement
- Inherited From
- Source
(protected) _name :string
插件名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Overrides
- Default Value
- 'switchModule'
- Source
(protected) _priority :number
优先级
插件优先级, 在安装插件是会按照优先级依次执行
Type:
- number
- Overrides
- Default Value
- 12
- Source
(readonly) name :string
创建名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Inherited From
- Source
(readonly) priority :number
优先级
插件优先级, 在安装插件是会按照优先级依次执行
Type:
- number
- Inherited From
- Source
Methods
install(live2d) → {void}
安装插件
在安装插件时需要调用的函数, 一般用于初始化以及事件绑定等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Overrides
- Source
Returns:
- Type:
- void
isEnable() → {boolean}
是否启用插件
根据相关条件判断插件是否启用
- Inherited From
- Source
Returns:
true: 启用
- Type:
- boolean
showLoading() → {boolean}
显示加载元素
是否应该显示加载元素, true: 显示加载, false: 不显示加载
- Overrides
- Source
Returns:
true: 显示加载, false: 不显示加载
- Type:
- boolean
(async) startSwitch() → {Promise.<void>}
开始切换
点击切换按钮后开始切换模型
- Inherited From
- Source
Returns:
- Type:
- Promise.<void>
(async) switch() → {Promise.<void>}
切换模型
用于切换模型或者服装
- Overrides
- Source
Returns:
- Type:
- Promise.<void>
uninstall(live2d) → {void}
卸载插件
在卸载插件时需要调用的函数, 一般用于销毁数据以及事件解绑等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Inherited From
- Source
Returns:
- Type:
- void