Class Sprite

精灵

Example

const node = new Sprite({
     texture: yourTexture
})

可以使用animations

const player = new Sprite({
     animations: engine.getAssets("player_ani")
})
player.play("run", true) // loop

Hierarchy (view full)

Drawable
- Sprite

Constructors

constructor

new Sprite(options): Sprite
Parameters
- options: ISpriteOptions
Returns Sprite
Overrides Drawable.constructor
- Defined in nodes/sprite.ts:57

Properties

`Private` aniLoop

aniLoop: boolean = false

aniPaused

aniPaused: boolean = false

是否暂停动画，如果想暂停动画，请设置该属性

`Private` animationTimer

animationTimer: Timer

`Optional` animations

animations?: Animations

动画

`Private` animatiosFarme

animatiosFarme: number = 0

children

children: Container[] = []

子节点列表

color

color: Color

颜色叠加

`Private` `Optional` currentAni

currentAni?: IAnimationFrames

`Private` `Optional` currentAniName

currentAniName?: string

destroyed

destroyed: boolean = false

是否被销毁

drawSize

drawSize: Vector2 = ...

绘制的大小

enableRegion

enableRegion: boolean = false

是否开启纹理裁剪

`Protected` engine

engine: SparkleEngine

event

event: EventEmitter<IContainerEvent>

`Readonly` globalPosition

globalPosition: Vector2 = ...

全局坐标

`Readonly` globalRotation

globalRotation: number = 0

全局旋转

inTree

inTree: boolean = false

是否在场景树中

`Protected` isReady

isReady: boolean = false

是否已就绪

offset

offset: Vector2

偏移

`Optional` parent

parent?: null | Container

父节点

pool

pool: PoolManager

对于对象池的引用

position

position: Vector2

坐标，坐标是相对于父的。若要设置全局坐标，请使用globalPosition

`Private` region

region: Rect = ...

`Protected` renderer

renderer: Renderer

resident

resident: boolean

是否为常驻节点，如果是常驻节点的话在切换场景时不会被销毁（其子节点同样不会被销毁）注意：常驻节点必须是根节点的一级子节点

rotation

rotation: number

旋转，旋转是相对于父的。若要设置全局旋转，请使用globalRotation

scale

scale: Vector2

缩放，缩放同样是相对父的

skew

skew: Vector2

斜切

tag

tag: Set<string>

Tag 用于节点查找，可以有多个tag

`Optional` texture

texture?: Texture

显示的纹理

textureRegion

textureRegion: Rect = ...

纹理裁剪区域

visible

visible: boolean = true

是否可见

Accessors

root

get root(): Container
Returns Container
Inherited from Drawable.root
- Defined in nodes/container.ts:59

Methods

addChild

addChild<T>(child): T
添加一个子节点
Type Parameters
- T extends Container
Parameters
- child: T
Returns T
Inherited from Drawable.addChild
- Defined in nodes/container.ts:122

`Private` animationsTimeOut

animationsTimeOut(): void
Returns void
- Defined in nodes/sprite.ts:99

`Private` clipRegion

clipRegion(): boolean
Returns boolean
- Defined in nodes/sprite.ts:125

destory

destory(): void
销毁这个节点

Returns void
Inherited from Drawable.destory
- Defined in nodes/container.ts:387

findAllByTag

findAllByTag(tag, deep?): Container[]
根据tag查找子节点
Parameters
- tag: string | string[]
  要查找的tag（支持多个）
- deep: boolean = true
Returns Container[]
找到的子节点数组
Inherited from Drawable.findAllByTag
- Defined in nodes/container.ts:332

findByTag

findByTag(tag, deep?): null | Container
Parameters
- tag: string | string[]
- deep: boolean = true
Returns null | Container
Inherited from Drawable.findByTag
- Defined in nodes/container.ts:346

getMouseGlobalPositon

getMouseGlobalPositon(): Vector2
获取鼠标的全局位置

Returns Vector2
Inherited from Drawable.getMouseGlobalPositon
- Defined in nodes/transform_2d.ts:58

getMouseLocalPositon

getMouseLocalPositon(): Vector2
获取鼠标相对于我的位置

Returns Vector2
Inherited from Drawable.getMouseLocalPositon
- Defined in nodes/transform_2d.ts:51

hide

hide(): void
隐藏等同于 this.visible = false

Returns void
Inherited from Drawable.hide
- Defined in nodes/drawable.ts:31

isChild

isChild(child): boolean
判断节点是不是子节点（包括所有子孙节点）
Parameters
- child: Container
Returns boolean
Inherited from Drawable.isChild
- Defined in nodes/container.ts:207

isParent

isParent(parent): boolean
判断节点是不是父节点（包括所有祖辈节点）
Parameters
- parent: Container
Returns boolean
Inherited from Drawable.isParent
- Defined in nodes/container.ts:188

offEvent

offEvent<T>(obj, eventName, func): void
使用该方法取消 onEvent 监听的事件
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
- func: T[keyof T]
Returns void
Inherited from Drawable.offEvent
- Defined in nodes/container.ts:99

onEnterTree

onEnterTree(): void
当进入场景树时被调用

Returns void
Inherited from Drawable.onEnterTree
- Defined in nodes/container.ts:297

onEvent

onEvent<T>(obj, eventName, func): void
使用该种方法监听事件，当节点被销毁时自动取消监听
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
- func: T[keyof T]
Returns void
Inherited from Drawable.onEvent
- Defined in nodes/container.ts:81

onExitTree

onExitTree(): void
当离开场景树时被调用

Returns void
Inherited from Drawable.onExitTree
- Defined in nodes/container.ts:301

onUpdate

onUpdate(_dt): void
每一帧调用
Parameters
- _dt: number
Returns void
Inherited from Drawable.onUpdate
- Defined in nodes/container.ts:311

play

play(name, loop?, restart?): void
播放某个动画，如果已经在播放目标动画，则不会重新播放若希望重新播放，请设置restart参数为true
Parameters
- name: string
  动画名称
- loop: boolean = false
  是否循环
- restart: boolean = false
  是否重启动画
Returns void
- Defined in nodes/sprite.ts:77

removeChild

removeChild(child): void
移除一个子节点
Parameters
- child: Container
Returns void
Inherited from Drawable.removeChild
- Defined in nodes/container.ts:159

removeFromParent

removeFromParent(): void
从父节点中移除当前节点

Returns void
Inherited from Drawable.removeFromParent
- Defined in nodes/container.ts:149

setAnimation

setAnimation(frame): void
设置动画帧
Parameters
- frame: number
Returns void
- Defined in nodes/sprite.ts:170

setParent

setParent(parent): void
设置父节点如果当前节点已经有父节点，则先从原来的父节点中移除
Parameters
- parent: Container
Returns void
Inherited from Drawable.setParent
- Defined in nodes/container.ts:131

setParentIndex

setParentIndex(index): void
设置所在的父节点的子排序
Parameters
- index: number
Returns void
Inherited from Drawable.setParentIndex
- Defined in nodes/container.ts:172

show

show(): void
显示等同于 this.visible = true

Returns void
Inherited from Drawable.show
- Defined in nodes/drawable.ts:25

stop

stop(): void
停止动画

Returns void
- Defined in nodes/sprite.ts:94

traverseChildren

traverseChildren(fn): any
遍历所有子节点
Parameters
- fn: ((child) => any)
  应用到每个子节点的函数。如果函数返回非false值，则停止遍历。
  - - (child): any
    - Parameters
      child: Container
      Returns any
Returns any
如果任何fn调用返回了非false值，则返回该值；否则返回false。
Inherited from Drawable.traverseChildren
- Defined in nodes/container.ts:366

waitEvent

waitEvent<T>(obj, eventName): Promise<unknown>
等待某个事件被触发，想实现等待1秒，那么就用该方法等待timer的事件
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
Returns Promise<unknown>
Inherited from Drawable.waitEvent
- Defined in nodes/container.ts:112

Class Sprite

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ISpriteOptions

Returns Sprite

Properties

Private aniLoop

aniPaused

Private animationTimer

Optional animations

Private animatiosFarme

children

color

Private Optional currentAni

Private Optional currentAniName

destroyed

drawSize

enableRegion

Protected engine

event

Readonly globalPosition

Readonly globalRotation

inTree

Protected isReady

offset

Optional parent

pool

position

Private region

Protected renderer

resident

rotation

scale

skew

tag

Optional texture

textureRegion

visible

Accessors

root

Returns Container

Methods

addChild

Type Parameters

T extends Container

Parameters

child: T

Returns T

Private animationsTimeOut

Returns void

Private clipRegion

Returns boolean

destory

Returns void

findAllByTag

Parameters

tag: string | string[]

deep: boolean = true

Returns Container[]

findByTag

Parameters

tag: string | string[]

deep: boolean = true

Returns null | Container

getMouseGlobalPositon

Returns Vector2

getMouseLocalPositon

Returns Vector2

hide

Returns void

isChild

Parameters

`Private` aniLoop

`Private` animationTimer

`Optional` animations

`Private` animatiosFarme

`Private` `Optional` currentAni

`Private` `Optional` currentAniName

`Protected` engine

`Readonly` globalPosition

`Readonly` globalRotation

`Protected` isReady

`Optional` parent

`Private` region

`Protected` renderer

`Optional` texture

`Private` animationsTimeOut

`Private` clipRegion