Class Container

constructor

• new Container(options?): Container

• Parameters

  • options: IContainerOptions = {}

  Returns Container

children

destroyed

event

inTree

Optional parent

pool

resident

tag

root

• get root(): Container

• Returns Container

addChild

• addChild<T>(child): T

• 添加一个子节点

  Type Parameters

  • T extends Container

  Parameters

  • child: T

  Returns T

destory

• destory(): void

• 销毁这个节点

  Returns void

findAllByTag

• findAllByTag(tag, deep?): Container[]

• 根据tag查找子节点

  Parameters

  • tag: string | string[]

    要查找的tag（支持多个）

  • deep: boolean = true

  Returns Container[]

  找到的子节点数组

findByTag

• findByTag(tag, deep?): null | Container

• Parameters

  • tag: string | string[]

  • deep: boolean = true

  Returns null | Container

getMouseGlobalPositon

• getMouseGlobalPositon(): Vector2

• 获取鼠标的全局位置，等同于 this.engine.mouse.mousePosition

  Returns Vector2

isChild

• isChild(child): boolean

• 判断节点是不是子节点（包括所有子孙节点）

  Parameters

  • child: Container

  Returns boolean

isParent

• isParent(parent): boolean

• 判断节点是不是父节点（包括所有祖辈节点）

  Parameters

  • parent: Container

  Returns boolean

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

onEnterTree

• onEnterTree(): void

• 当进入场景树时被调用

  Returns void

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

onExitTree

• onExitTree(): void

• 当离开场景树时被调用

  Returns void

onUpdate

• onUpdate(_dt): void

• 每一帧调用

  Parameters

  • _dt: number

  Returns void

removeChild

• removeChild(child): void

• 移除一个子节点

  Parameters

  • child: Container

  Returns void

removeFromParent

• removeFromParent(): void

• 从父节点中移除当前节点

  Returns void

setParent

• setParent(parent): void

• 设置父节点 如果当前节点已经有父节点，则先从原来的父节点中移除

  Parameters

  • parent: Container

  Returns void

setParentIndex

• setParentIndex(index): void

• 设置所在的父节点的子排序

  Parameters

  • index: number

  Returns void

traverseChildren

• traverseChildren(fn): any

• 遍历所有子节点

  Parameters

  • fn: ((child) => any)

    应用到每个子节点的函数。如果函数返回非false值，则停止遍历。

    • • (child): any

      • Parameters

        • child: Container

        Returns any

  Returns any

  如果任何fn调用返回了非false值，则返回该值；否则返回false。

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>