modules# DLive2dOptions

Live2d 数据集合, 用于存储 live2d 对应的数据

Constructor

new DLive2dOptions(dataopt)

Live2d 数据类

创建 live2d 数据实例

Parameters:
NameTypeAttributesDefaultDescription
dataDLive2dOptions | null<optional>
null

live2d 数据

Members

(nullable) drag :boolean

启用拖拽

如果是 true, 则启用 wrapper 元素的拖拽, 否则不启用拖拽

Type:
  • boolean
Default Value
  • true

(nullable) fixed :boolean

组件固定定位

组件是否使用固定定位

注意, 关闭这个属性后舞台的定位属性将从 fixed 改为 relative, 使舞台回到文档流, 另外该属性不影响状态条定位属性, 状态条与舞台之间相互独立,样式互不干扰.

Type:
  • boolean
Default Value
  • true

(nullable) homePath :string

url 路径

homePath 是一个 url 路径, 将完整的拼接在 URL.origin 后面

Type:
  • string
Default Value
  • ''
Example
let url = 'https://localhost/live2d';
// origin   => https://localhost
// homePath => /live2d

菜单项

默认你启用的菜单项

Type:
  • Array.<string>
Default Value
  • ['home', 'switchTexture', 'switchModule', 'capture', 'info', 'quit']
Example
[
  'home', 'switchTexture', 'switchModule',
  'capture', 'info', 'quit'
]

(nullable) models :TModels

模型配置

模型配置, 默认值是空数组, 请至少配置一个有效的模型配置

前往TModels模型选项查看详细内容

Type:
Default Value
  • []

(nullable) plugins :Array.<FBasePlugin>

插件

需要使用的插件集

Type:
Default Value
  • []

(nullable) sayHello :boolean

打印项目信息

是否在初始化阶段打印项目信息

Type:
  • boolean
Default Value
  • true

(nullable) selector :string

父元素选择器

父元素的选择器, 支持 css 选择器语法, 以及 xpath 语法. 默认父元素为 document.body

Type:
  • string
Default Value
  • ''
Example
'#id'           // => document.querySelector('#id');
'//*[@id="id"]' // => document.evaluate('//*[@id="id"]', document).iterateNext();

(nullable) tips :DTips

消息提示配置

自定义提示框样式和内容, 前往 DTips 提示框选项查看详细内容

Type:
Default Value
  • null

(nullable) transitionTime :number

过渡动画时长

模型入场和离开的过渡动画时长,单位 ms

Type:
  • number
Default Value
  • 500