plugins FTalkMessagePlugin

用于获取随机消息的消息提示插件

Extends

Members

(protected) _enable :boolean

启用插件

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

Type:
  • boolean
Inherited From
Default Value
  • true

(protected, nullable) _handler :number

定时器 id

时间间隔定时器 id

Type:
  • number
Default Value
  • null

(protected) _live2d :ULive2dController

live2d 上下文

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

Inherited From

(protected) _message :DMessageExtend

随机消息

获取的随机消息所使用的消息载体

(protected) _name :string

插件名称

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

Type:
  • string
Default Value
  • 'sentenceMessage'

(protected) _priority :number

优先级

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

Type:
  • number
Default Value
  • 20

(protected) _talkApis :Array.<TTalkApi>

talk api 对象

用于存储 url 以及处理 talk 结果的对象

Type:
Default Value
  • []

(protected) _type :string

消息类型

消息数据对应的类型

Type:
  • string
Default Value
  • 'talk'

(readonly) name :string

创建名称

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

Type:
  • string
Inherited From

(readonly) priority :number

优先级

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

Type:
  • number
Inherited From

Methods

condition(tips) → {boolean}

条件判断

消息实例的判断函数, 用于判断是否显示消息

Parameters:
NameTypeDescription
tipsUTipsController

tips 控制器

Returns:

true: 可以显示该消息

Type: 
boolean

(async) getTalkValue() → {Promise.<void>}

获取随机文本

间隔一定时间后获获取随机文本, 并将该消息添加到 tips 的消息集中

Returns:
Type: 
Promise.<void>

install(live2d) → {void}

安装插件

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

Parameters:
NameTypeDescription
live2dULive2dController

live2d 上下文

Returns:
Type: 
void

isEnable() → {boolean}

是否启用插件

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

Returns:

true: 启用

Type: 
boolean

uninstall(live2d) → {void}

卸载插件

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

Parameters:
NameTypeDescription
live2dULive2dController

live2d 上下文

Returns:
Type: 
void