Class Timer

计时器节点，有个timeout信号 timer必须在场景树里才会运行，若在场景树之外处于暂停状态若想让在场景树之外的timer同样保持运行，请手动调用update

onUpdate(dt){
     timer.update(dt)
}

Example

cosnt node = new Timer({
     waitTime: 1,
     initTimeLeft: 1,
     start: true
})
node.onTimeout = ()=>{} // 或者是用信号onTimeout

该节点的所有事件：ITimerEvents

Hierarchy (view full)

Container
- Timer

Implements

IEventAble<ITimerEvents>

Index

Constructors

constructor

new Timer(options): Timer
Parameters
- options: ITimerOptions
Returns Timer
Overrides Container.constructor
- Defined in nodes/timer.ts:46

Properties

children

children: Container[] = []

子节点列表

destroyed

destroyed: boolean = false

是否被销毁

`Protected` engine

engine: SparkleEngine

event

event: EventEmitter<ITimerEvents>

inTree

inTree: boolean = false

是否在场景树中

`Protected` isReady

isReady: boolean = false

是否已就绪

`Private` isStart

isStart: boolean = false

oneShot

oneShot: boolean

是否只触发一次如果为true会一直重复循环

`Optional` parent

parent?: null | Container

父节点

paused

paused: boolean = false

是否暂停

pool

pool: PoolManager

对于对象池的引用

`Protected` renderer

renderer: Renderer

resident

resident: boolean

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

tag

tag: Set<string>

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

timeLeft

timeLeft: number

timer 剩余的时间（可以更改）

waitTime

waitTime: number

计时器等待的时间

Accessors

root

get root(): Container
Returns Container
Inherited from Container.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 Container.addChild
- Defined in nodes/container.ts:122

destory

destory(): void
销毁这个节点

Returns void
Inherited from Container.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 Container.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 Container.findByTag
- Defined in nodes/container.ts:346

getMouseGlobalPositon

getMouseGlobalPositon(): Vector2
获取鼠标的全局位置，等同于 this.engine.mouse.mousePosition

Returns Vector2
Inherited from Container.getMouseGlobalPositon
- Defined in nodes/container.ts:316

isChild

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

isParent

isParent(parent): boolean
判断节点是不是父节点（包括所有祖辈节点）
Parameters
- parent: Container
Returns boolean
Inherited from Container.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 Container.offEvent
- Defined in nodes/container.ts:99

onEnterTree

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

Returns void
Inherited from Container.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 Container.onEvent
- Defined in nodes/container.ts:81

onExitTree

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

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

onTimeout

onTimeout(): void
timeout 时调用

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

onUpdate

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

removeChild

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

removeFromParent

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

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

setParent

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

setParentIndex

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

start

start(): void
开启

Returns void
- Defined in nodes/timer.ts:87

stop

stop(): void
关闭

Returns void
- Defined in nodes/timer.ts:80

`Private` timeout

timeout(): void
Returns void
- Defined in nodes/timer.ts:70

traverseChildren

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

Class Timer

Example

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ITimerOptions

Returns Timer

Properties

children

destroyed

Protected engine

event

inTree

Protected isReady

Private isStart

oneShot

Optional parent

paused

pool

Protected renderer

resident

tag

timeLeft

waitTime

Accessors

root

Returns Container

Methods

addChild

Type Parameters

T extends Container

Parameters

child: T

Returns T

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

isChild

Parameters

child: Container

Returns boolean

isParent

Parameters

parent: Container

Returns boolean

offEvent

Type Parameters

T extends Record<string, any>

Parameters

obj: IEventAble<T>

eventName: keyof T

func: T[keyof T]

Returns void

onEnterTree

Returns void

onEvent

Type Parameters

T extends Record<string, any>

Parameters

obj: IEventAble<T>

eventName: keyof T

func: T[keyof T]

`Protected` engine

`Protected` isReady

`Private` isStart

`Optional` parent

`Protected` renderer

`Private` timeout