- Source
Extends
Members
(protected) _element :HTMLElement
拖拽的元素
需要进行拖拽的元素 - stage.wrapper
Type:
- HTMLElement
- Source
(protected) _enable :boolean
启用插件
true: 启用插件, false: 不启用插件
Type:
- boolean
- Inherited From
- Default Value
- true
- Source
(protected) _event :MouseEvent|TouchEvent
拖拽事件数据
拖拽时的上一个事件数据
Type:
- MouseEvent |
TouchEvent
- Source
(protected) _isLeft :boolean
wrapper 的左右位置
true: wrapper 在左边, false: wrapper 在右边
Type:
- boolean
- Default Value
- true
- Source
(protected) _live2d :ULive2dController
live2d 上下文
插件 live2d 上下文, 用于获取对应的数据
Type:
- Inherited From
- Source
(protected) _name :string
插件名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Overrides
- Default Value
- 'drag'
- Source
(protected) _priority :number
优先级
插件优先级, 在安装插件是会按照优先级依次执行
Type:
- number
- Inherited From
- Default Value
- 0
- Source
(protected) _ref :Record.<string, function()>
对象引用
以键值对进行记录的对象引用
Type:
- Record.<string, function()>
- Default Value
- {}
- Source
(protected) _screen :TRect
窗口宽高
当前窗口显示区域的宽高
Type:
- Source
(readonly) name :string
创建名称
插件名称必须是唯一的, 如果有重复的名称, 则后面的插件将不会安装
Type:
- string
- Inherited From
- Source
(readonly) priority :number
优先级
插件优先级, 在安装插件是会按照优先级依次执行
Type:
- number
- Inherited From
- Source
Methods
(protected) _end()
拖拽结束
当鼠标离开或者触摸结束时清除事件
- Source
(protected) _run(event)
运行拖拽
当鼠标移动或者触摸移动时持续更新拖拽位置
Parameters:
| Name | Type | Description |
|---|---|---|
event | MouseEvent | | 鼠标事件 | 触摸事件 |
- Source
(protected) _start(event)
拖拽开始
当鼠标按下或者触摸开始时开始拖拽 element 元素
Parameters:
| Name | Type | Description |
|---|---|---|
event | MouseEvent | | 拖拽时的初始事件 |
- Source
getDragElement() → {HTMLElement}
获取拖拽元素
获取当前需要进行拖拽的元素
- Source
Returns:
- Type:
- HTMLElement
getWidthHeight() → {TRect}
获取窗口宽高
获取当前窗口显示区域的宽高
- Source
Returns:
宽高
- Type:
- TRect
install(live2d) → {void}
安装插件
在安装插件时需要调用的函数, 一般用于初始化以及事件绑定等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Overrides
- Source
Returns:
- Type:
- void
isEnable() → {boolean}
是否启用插件
根据相关条件判断插件是否启用
- Overrides
- Source
Returns:
true: 启用
- Type:
- boolean
uninstall(live2d) → {void}
卸载插件
在卸载插件时需要调用的函数, 一般用于销毁数据以及事件解绑等等
Parameters:
| Name | Type | Description |
|---|---|---|
live2d | ULive2dController | live2d 上下文 |
- Overrides
- Source
Returns:
- Type:
- void