Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Live2d

Live2d动画
可监听的事件：loaded,ended

Hierarchy

Implements

  • IAnimatable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

currentTime

currentTime: number = 0

data

data: any = undefined

扩展字段，可以用来存储任意数据

duration

duration: number = 1000

id

id: number = -1

节点ID，由编辑器生成

model

model: Live2DModel

Live2D模型

playbackRate

playbackRate: number = 1

playing

playing: boolean = false

Static isInit

isInit: boolean = false

Live2d是否已经初始化

Accessors

alpha

  • get alpha(): number
  • set alpha(value: number): void

  • 透明度

    Returns number

  • 透明度

    Parameters

    • value: number

    Returns void

anchorX

  • get anchorX(): number
  • set anchorX(value: number): void

  • 相对父节点水平轴心点的百分比，轴心点是旋转缩放的中心点，一般取值为0-1

    Returns number

  • 相对父节点水平轴心点的百分比，轴心点是旋转缩放的中心点，一般取值为0-1

    Parameters

    • value: number

    Returns void

anchorY

  • get anchorY(): number
  • set anchorY(value: number): void

  • 相对父节点垂直轴心点的百分比，轴心点是旋转缩放的中心点，一般取值为0-1

    Returns number

  • 相对父节点垂直轴心点的百分比，轴心点是旋转缩放的中心点，一般取值为0-1

    Parameters

    • value: number

    Returns void

animName

  • get animName(): string
  • set animName(value: string): void

  • 动画名称

    Returns string

  • 动画名称

    Parameters

    • value: string

    Returns void

asMask

  • get asMask(): boolean
  • set asMask(value: boolean): void

  • 是否把当前节点作为遮罩，如果为true，则遮罩父对象

    Returns boolean

  • 是否把当前节点作为遮罩，如果为true，则遮罩父对象

    Parameters

    • value: boolean

    Returns void

autoPlay

  • get autoPlay(): boolean
  • set autoPlay(value: boolean): void

  • 自动轮播动画

    Returns boolean

  • 自动轮播动画

    Parameters

    • value: boolean

    Returns void

bgColor

  • get bgColor(): string
  • set bgColor(value: string): void

  • 背景颜色

    Returns string

  • 背景颜色

    Parameters

    • value: string

    Returns void

blendMode

  • get blendMode(): "normal" | "multiply" | "screen" | "overlay" | "add"
  • set blendMode(value: "normal" | "multiply" | "screen" | "overlay" | "add"): void

  • 混合模式，支持以下模式: normal: 正常模式 multiply: 正片叠底-把两层图像的像素相乘，最后会得到一个更暗的图像 screen: 滤色-正片叠底得到的结果是相反的。它会得到一个更亮的图像 overlay: 叠加-结合了正片叠底和滤色两种混合模式。基色中亮色的部分会更加亮，而暗色的部分会更暗 add: 增加-将原始图像及混合图像的对应像素取出来并加在一起

    Returns "normal" | "multiply" | "screen" | "overlay" | "add"

  • 混合模式，支持以下模式: normal: 正常模式 multiply: 正片叠底-把两层图像的像素相乘，最后会得到一个更暗的图像 screen: 滤色-正片叠底得到的结果是相反的。它会得到一个更亮的图像 overlay: 叠加-结合了正片叠底和滤色两种混合模式。基色中亮色的部分会更加亮，而暗色的部分会更暗 add: 增加-将原始图像及混合图像的对应像素取出来并加在一起

    Parameters

    • value: "normal" | "multiply" | "screen" | "overlay" | "add"

    Returns void

blur

  • get blur(): number
  • set blur(value: number): void

  • 模糊滤镜的强度(值越大，越不清晰)

    Returns number

  • 模糊滤镜的强度(值越大，越不清晰)

    Parameters

    • value: number

    Returns void

borderColor

  • get borderColor(): string
  • set borderColor(value: string): void

  • 边框颜色

    Returns string

  • 边框颜色

    Parameters

    • value: string

    Returns void

bottom

  • get bottom(): number
  • set bottom(value: number): void

  • 下边距，设置后，会根据父对象大小确定y的数值

    Returns number

  • 下边距，设置后，会根据父对象大小确定y的数值

    Parameters

    • value: number

    Returns void

brightness

  • get brightness(): number
  • set brightness(value: number): void

  • 亮度，取值范围:-100~100

    Returns number

  • 亮度，取值范围:-100~100

    Parameters

    • value: number

    Returns void

center

  • get center(): number
  • set center(value: number): void

  • 水平居中偏移，设置后，会根据父对象大小确定x的数值

    Returns number

  • 水平居中偏移，设置后，会根据父对象大小确定x的数值

    Parameters

    • value: number

    Returns void

color

  • get color(): string
  • set color(value: string): void

  • 滤镜颜色

    Returns string

  • 滤镜颜色

    Parameters

    • value: string

    Returns void

contrast

  • get contrast(): number
  • set contrast(value: number): void

  • 对比度，取值范围:-100~100

    Returns number

  • 对比度，取值范围:-100~100

    Parameters

    • value: number

    Returns void

destroyed

  • get destroyed(): boolean

  • 是否已经被销毁，销毁后，不能再执行任何操作

    Returns boolean

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

  • 是否启用节点，如果不启用，则不可见，同时脚本不执行

    Returns boolean

  • 是否启用节点，如果不启用，则不可见，同时脚本不执行

    Parameters

    • value: boolean

    Returns void

fillType

  • 填充类型

    Returns FillType

  • 填充类型

    Parameters

    Returns void

globalEnabled

  • get globalEnabled(): boolean

  • 自己及自己的父节点是否激活

    Returns boolean

globalRotation

  • get globalRotation(): number

  • 全局旋转角度

    Returns number

graphics

  • get graphics(): Graphics

  • 矢量图绘制单元

    Returns Graphics

height

  • get height(): number
  • set height(value: number): void

  • 高

    Returns number

  • 高

    Parameters

    • value: number

    Returns void

hue

  • get hue(): number
  • set hue(value: number): void

  • 色调，取值范围:-180~180

    Returns number

  • 色调，取值范围:-180~180

    Parameters

    • value: number

    Returns void

isInScene

  • get isInScene(): boolean

  • 是否还在场景中，如果自己或者自己的父节点被移除，则为false

    Returns boolean

left

  • get left(): number
  • set left(value: number): void

  • 左边距，设置后，会根据父对象大小确定x的数值

    Returns number

  • 左边距，设置后，会根据父对象大小确定x的数值

    Parameters

    • value: number

    Returns void

mask

  • get mask(): undefined | Sprite
  • set mask(value: undefined | Sprite): void

  • 遮罩（蒙层），设置别的对象为当前节点蒙层，则会以设置的对象形状显示

    Returns undefined | Sprite

  • 遮罩（蒙层），设置别的对象为当前节点蒙层，则会以设置的对象形状显示

    Parameters

    Returns void

middle

  • get middle(): number
  • set middle(value: number): void

  • 垂直居中偏移，设置后，会根据父对象大小确定y的数值

    Returns number

  • 垂直居中偏移，设置后，会根据父对象大小确定y的数值

    Parameters

    • value: number

    Returns void

mouseEnabled

  • get mouseEnabled(): boolean
  • set mouseEnabled(value: boolean): void

  • 是否接受鼠标事件，默认为false，节点被添加鼠标事件后，会变为true

    Returns boolean

  • 是否接受鼠标事件，默认为false，节点被添加鼠标事件后，会变为true

    Parameters

    • value: boolean

    Returns void

name

  • get name(): string
  • set name(value: string): void

  • 节点名称

    Returns string

  • 节点名称

    Parameters

    • value: string

    Returns void

numChildren

  • get numChildren(): number

  • 子节点的数量

    Returns number

parent

  • get parent(): undefined | Node

  • 父亲节点，只有被添加到别的节点中，才会有值

    Returns undefined | Node

pivotX

  • get pivotX(): number
  • set pivotX(value: number): void

  • 水平轴心点，轴心点是旋转缩放的中心点，单位像素

    Returns number

  • 水平轴心点，轴心点是旋转缩放的中心点，单位像素

    Parameters

    • value: number

    Returns void

pivotY

  • get pivotY(): number
  • set pivotY(value: number): void

  • 垂直轴心点，轴心点是旋转缩放的中心点，单位像素

    Returns number

  • 垂直轴心点，轴心点是旋转缩放的中心点，单位像素

    Parameters

    • value: number

    Returns void

right

  • get right(): number
  • set right(value: number): void

  • 右边距，设置后，会根据父对象大小确定x的数值

    Returns number

  • 右边距，设置后，会根据父对象大小确定x的数值

    Parameters

    • value: number

    Returns void

root

  • get root(): undefined | IAnimation

  • 获得所在的根节点，如果是互动组件，则是 Animation，否者和 this.scene 相同

    Returns undefined | IAnimation

rotation

  • get rotation(): number
  • set rotation(value: number): void

  • 旋转角度

    Returns number

  • 旋转角度

    Parameters

    • value: number

    Returns void

saturation

  • get saturation(): number
  • set saturation(value: number): void

  • 饱和度，取值范围:-100~100

    Returns number

  • 饱和度，取值范围:-100~100

    Parameters

    • value: number

    Returns void

scaleX

  • get scaleX(): number
  • set scaleX(value: number): void

  • 水平缩放值

    Returns number

  • 水平缩放值

    Parameters

    • value: number

    Returns void

scaleY

  • get scaleY(): number
  • set scaleY(value: number): void

  • 垂直缩放值

    Returns number

  • 垂直缩放值

    Parameters

    • value: number

    Returns void

scene

  • get scene(): undefined | Scene

  • 获得所在的场景节点，只有被添加到场景中，才会有值

    Returns undefined | Scene

skewX

  • get skewX(): number
  • set skewX(value: number): void

  • 水平倾斜角度，单位为角度

    Returns number

  • 水平倾斜角度，单位为角度

    Parameters

    • value: number

    Returns void

skewY

  • get skewY(): number
  • set skewY(value: number): void

  • 垂直倾斜角度，单位为角度

    Returns number

  • 垂直倾斜角度，单位为角度

    Parameters

    • value: number

    Returns void

top

  • get top(): number
  • set top(value: number): void

  • 上边距，设置后，会根据父对象大小确定y的数值

    Returns number

  • 上边距，设置后，会根据父对象大小确定y的数值

    Parameters

    • value: number

    Returns void

url

  • get url(): string
  • set url(value: string): void

  • 动画资源url地址

    Returns string

  • 动画资源url地址

    Parameters

    • value: string

    Returns void

visible

  • get visible(): boolean
  • set visible(value: boolean): void

  • 是否可见

    Returns boolean

  • 是否可见

    Parameters

    • value: boolean

    Returns void

width

  • get width(): number
  • set width(value: number): void

  • 宽

    Returns number

  • 宽

    Parameters

    • value: number

    Returns void

x

  • get x(): number
  • set x(value: number): void

  • 水平轴坐标

    Returns number

  • 水平轴坐标

    Parameters

    • value: number

    Returns void

y

  • get y(): number
  • set y(value: number): void

  • 垂直轴坐标

    Returns number

  • 垂直轴坐标

    Parameters

    • value: number

    Returns void

Methods

addChild

  • 添加子节点

    Parameters

    • node: Node

      子节点

    Returns Node

addChildAt

  • addChildAt(node: Node, index: number): Node

  • 在某个索引下添加子节点

    Parameters

    • node: Node

      子节点

    • index: number

      索引

    Returns Node

addRigidBody

addScript

  • 添加脚本，脚本由场景统一驱动

    Parameters

    Returns undefined | Script

anchor

  • anchor(anchorX: number, anchorY: number): Sprite

  • 设置轴心点百分比，轴心点是旋转缩放的中心点

    Parameters

    • anchorX: number

      水平轴心百分比

    • anchorY: number

      垂直轴心百分比

    Returns Sprite

contains

  • contains(target: Node): boolean

  • 自己或者孩子是否包含该节点

    Parameters

    • target: Node

      目标节点

    Returns boolean

destroy

  • destroy(): void

  • 销毁节点，销毁后，不能再执行任何操作

    Returns void

destroyChildren

  • destroyChildren(): void

  • 销毁所有子节点

    Returns void

destroyScripts

  • destroyScripts(scriptClass?: typeof Script): void

  • 销毁指定类型的脚本，如果类型参数为空，则删除当前对象身上的所有脚本

    Parameters

    • Optional scriptClass: typeof Script

      脚本类型

    Returns void

emit

  • emit(type: string, data?: unknown[]): void

  • 派发事件

    Parameters

    • type: string

      事件类型

    • Optional data: unknown[]

      派发的数据（可选）

    Returns void

fromJson

  • fromJson(json: INodeData): Promise<void>

  • 根据json创建节点信息

    Parameters

    • json: INodeData

      节点数据，一般是由编辑器生成的json数据

    Returns Promise<void>

getById

  • getById(id: number): undefined | Node

  • 从根节点（编辑器文件的根节点，如果没有则为this），根据id获得节点

    Parameters

    • id: number

      编辑器内的节点id

    Returns undefined | Node

getChildAt

  • getChildAt(index: number): Node

  • 根据索引获得子节点

    Parameters

    • index: number

      索引

    Returns Node

getChildByName

  • getChildByName(name: string, deep?: boolean): undefined | Node

  • 根据名称获得子节点

    Parameters

    • name: string

      名称

    • deep: boolean = false

      是否递归搜索

    Returns undefined | Node

getChildIndex

  • getChildIndex(node: Node): number

  • 获得子节点索引数

    Parameters

    • node: Node

      子节点

    Returns number

getPixel

  • getPixel(x: number, y: number): null | Uint8Array

  • 获得像素数据

    Parameters

    • x: number

      水平坐标

    • y: number

      垂直坐标

    Returns null | Uint8Array

getRigidBody

  • 获取已经设置好的2D物理刚体

    Returns undefined | RigidBody

getScript

  • getScript<T>(ScriptClass?: T, deep?: boolean): undefined | InstanceType<T>

  • 获取绑定到该节点的第一个脚本实例

    Type parameters

    • T: new (...args: any[]) => Script

    Parameters

    • ScriptClass: T = ...

      脚本类型

    • deep: boolean = false

      如果是true，则遍历所有子对象，返回第一个脚本实例，默认为false

    Returns undefined | InstanceType<T>

    返回绑定到该节点的第一个脚本实例

getScriptByName

  • getScriptByName(name: string): undefined | Script

  • 根据名称获取绑定到该节点的所有脚本实例

    Parameters

    • name: string

      脚本名称

    Returns undefined | Script

    返回绑定到该节点的第一个脚本实例

getScripts

  • getScripts<T>(ScriptClass?: T, deep?: boolean): InstanceType<T>[]

  • 获取绑定到该节点的所有脚本实例

    Type parameters

    • T: new (...args: any[]) => Script

    Parameters

    • ScriptClass: T = ...

      脚本类型

    • deep: boolean = false

      如果是true，则遍历所有子对象的脚本实例，默认为false

    Returns InstanceType<T>[]

    返回绑定到该节点的所有脚本实例

globalScaleX

  • globalScaleX(globalNode?: Node): number

  • 获得全局缩放值，值为从舞台到节点缩放值相乘

    Parameters

    • Optional globalNode: Node

      相对的全局节点，默认为stage

    Returns number

globalScaleY

  • globalScaleY(globalNode?: Node): number

  • 获得全局缩放值，值为从舞台到节点缩放值相乘

    Parameters

    • Optional globalNode: Node

      相对的全局节点，默认为stage

    Returns number

globalToLocal

  • globalToLocal(x: number, y: number, globalNode?: Sprite): Point

  • 将全局坐标转换为相对于本节点的坐标

    Parameters

    • x: number

      全局X坐标

    • y: number

      全局Y坐标

    • Optional globalNode: Sprite

      相对的全局节点，默认为stage

    Returns Point

gotoAndStop

  • gotoAndStop(time: number): void

  • Parameters

    • time: number

    Returns void

load

  • load(url: string): Promise<void>

  • 根据地址加载节点数据并解析

    Parameters

    • url: string

      节点数据地址

    Returns Promise<void>

loadImage

  • loadImage(url: string): Promise<void>

  • 加载显示一个图片

    Parameters

    • url: string

      图片地址

    Returns Promise<void>

localToGlobal

  • localToGlobal(x: number, y: number, globalNode?: Sprite): Point

  • 将相对本节点的坐标，转换为全局坐标

    Parameters

    • x: number

      相对节点X坐标

    • y: number

      相对节点Y坐标

    • Optional globalNode: Sprite

      相对的全局节点，默认为stage

    Returns Point

off

  • off(type: string, listener: (...args: any[]) => void, caller?: unknown): void

  • 取消事件监听

    Parameters

    • type: string

      事件类型

    • listener: (...args: any[]) => void

      监听函数

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    Returns void

offAll

  • offAll(caller?: unknown): void

  • 移除当前节点身上所有caller的事件监听 如果caller为空，则清理当前节点下的所有事件监听

    Parameters

    • Optional caller: unknown

    Returns void

on

  • on<A>(type: "click" | "mouseup" | "mousedown" | "mousemove" | "loaded" | "ended" | "enabled" | "textChanged", listener: A, caller?: unknown, args?: Parameters<A>): void
  • on<A>(type: string, listener: A, caller?: unknown, args?: Parameters<A>): void

  • 监听事件，不用或者销毁时，需要使用off函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: "click" | "mouseup" | "mousedown" | "mousemove" | "loaded" | "ended" | "enabled" | "textChanged"

      事件类型

    • listener: A

      监听函数

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    • Optional args: Parameters<A>

      传入的参数，在listener内可以接收到

    Returns void

  • Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: string
    • listener: A
    • Optional caller: unknown
    • Optional args: Parameters<A>

    Returns void

once

  • once<A>(type: string, listener: A, caller?: unknown, args?: Parameters<A>): void

  • 监听事件，在事件被执行后，取消继续监听，不用或者销毁时，需要使用off函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • type: string

      事件类型

    • listener: A

      监听函数

    • Optional caller: unknown

      函数的主体（一般是this，箭头函数可以省略）

    • Optional args: Parameters<A>

      传入的参数，在listener内可以接收到

    Returns void

pivot

  • pivot(pivotX: number, pivotY: number): Sprite

  • 设置轴心点，轴心点是旋转缩放的中心点

    Parameters

    • pivotX: number

      水平轴心点

    • pivotY: number

      垂直轴心点

    Returns Sprite

play

  • play(): void

  • Returns void

pos

  • pos(x: number, y: number): Sprite

  • 设置位置

    Parameters

    • x: number

      x坐标

    • y: number

      y坐标

    Returns Sprite

removeChild

  • 移除子节点

    Parameters

    • node: Node

      子节点

    Returns Node

removeChildAt

  • removeChildAt(index: number): Node

  • 根据索引移除子节点

    Parameters

    • index: number

      索引

    Returns Node

removeChildByName

  • removeChildByName(name: string): Node

  • 根据名称移除子节点

    Parameters

    • name: string

      节点名称

    Returns Node

removeChildren

  • removeChildren(): void

  • 移除所有子节点

    Returns void

removeSelf

  • 把自己从父节点删除

    Returns Node

repaint

  • repaint(): void

  • 重绘对象，大部分时候不需要手动调用

    Returns void

scale

  • scale(scaleX: number, scaleY: number): Sprite

  • 设置缩放

    Parameters

    • scaleX: number

      水平缩放值

    • scaleY: number

      垂直缩放值

    Returns Sprite

setChildIndex

  • setChildIndex(node: Node, index: number): Node

  • 设置子节点索引

    Parameters

    • node: Node

      子节点

    • index: number

      索引

    Returns Node

setProp

  • setProp(prop: string, value: unknown): void

  • 设置节点的属性值

    Parameters

    • prop: string

      属性名

    • value: unknown

      属性值

    Returns void

size

  • size(width: number, height: number): Sprite

  • 设置大小

    Parameters

    • width: number

      宽度

    • height: number

      高度

    Returns Sprite

startDrag

  • 开始拖动

    Parameters

    • Optional area: Rectangle

      （可选）拖动区域，此区域为当前对象注册点活动区域（不包括对象宽高），可选。

    Returns void

stop

  • stop(): void

  • Returns void

stopDrag

  • stopDrag(): void

  • 停止拖动

    Returns void

Static initialize

  • initialize(): void

  • 初始化Live2d

    Returns void