- Source
Extends
Members
(protected) _enable :boolean
启用插件
true: 启用插件, false: 不启用插件
Type:
- boolean
- Inherited From
- Default Value
- true
- Source
(protected) _live2d :ULive2dController
live2d 上下文
插件 live2d 上下文, 用于获取对应的数据
Type:
- Inherited From
- Source
(protected) _messages :Array.<DMessageExtend>
消息集
与 type 对应的消息集合
Type:
- Array.<DMessageExtend>
- Default Value
- []
- Source
(protected) _name :string
插件名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Overrides
- Default Value
- 'nullMessage'
- Source
(protected) _priority :number
优先级
既是消息提示的优先级, 也是插件的优先级
Type:
- number
- Overrides
- Default Value
- 2
- Source
(protected, nullable) _type :string
消息类型
消息数据对应的类型
Type:
- string
- Default Value
- null
- Source
(readonly) name :string
创建名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Inherited From
- Source
(readonly) priority :number
优先级
插件优先级, 在安装插件是会按照优先级依次执行
Type:
- number
- Inherited From
- Source
Methods
condition() → {boolean}
条件判断
消息实例的判断函数, 用于判断是否显示消息
This:
- Source
Returns:
true: 可以显示该消息
- Type:
- boolean
install(live2d) → {void}
安装插件
在安装插件时需要调用的函数, 一般用于初始化, 类型混合, 消息筛选以及事件绑定等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Overrides
- Source
Returns:
- Type:
- void
isEnable() → {boolean}
是否启用插件
根据相关条件判断插件是否启用
- Overrides
- Source
Returns:
true: 启用
- Type:
- boolean
isType(message) → {boolean}
判断消息类型
判断消息类型是否与指定的类型相同
Parameters:
| Name | Type | Description |
|---|---|---|
message | DMessageExtend | 需需要判断的消息 |
- Source
Returns:
true: 相同
- Type:
- boolean
mixin()
混合类型
将一个类型混合到 DMessage 中
- Source
setDefault(message)
恢复默认值
卸载时恢复消息实例的默认值
Parameters:
| Name | Type | Description |
|---|---|---|
message | DMessageExtend | 消息实例 |
- Source
uninstall(live2d) → {void}
卸载插件
在卸载插件时需要调用的函数, 一般用于销毁数据以及恢复消息默认值等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Overrides
- Source
Returns:
- Type:
- void