xr-frame / Exports / TickSystem

# Class: TickSystem

Tick系统,负责整个场景生命周期的驱动。

# Hierarchy

# Table of contents

# Constructors

# Events

# Properties

# Accessors

# Methods

# Constructors

# constructor

new TickSystem()

# Inherited from

Component.constructor

# Events

# onAdd

onAdd(parent, data): void

所挂载的element被挂载到场景时触发的回调。

# Parameters

Name Type
parent Element
data ITickSystemData

# Returns

void

# Inherited from

Component.onAdd


# onRelease

onRelease(data): void

从被挂载的element上被移除,或是element被销毁时,触发的回调。 一般用于释放持有的资源。

# Parameters

Name Type
data ITickSystemData

# Returns

void

# Inherited from

Component.onRelease


# onRemove

onRemove(parent, data): void

所挂载的element从父节点parent被移除时,或者自己从element上被移除时,触发的回调。 一般用于消除功能的运作。 如果一个组件的元素直接被销毁了,那这个组件就不会经历onRemove而是直接进入onRelease。

# Parameters

Name Type
parent Element
data ITickSystemData

# Returns

void

# Inherited from

Component.onRemove


# onTick

onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

Name Type
deltaTime number
data ITickSystemData

# Returns

void

# Inherited from

Component.onTick


# onUpdate

onUpdate(data, preData): void

数据更新时触发的回调。

# Parameters

Name Type
data ITickSystemData
preData ITickSystemData

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# priority

Readonly priority: number = 300

自定义组件的更新优先级。

# Overrides

Component.priority


# schema

Readonly schema: IComponentSchema = {}

自定义组件的schema

# Inherited from

Component.schema


# EVENTS

Static EVENTS: string[] = []

# Inherited from

Component.EVENTS

# Accessors

# el

get el(): Element

挂载的元素。

# Returns

Element


# scene

get scene(): Scene

当前场景。

# Returns

Scene


# version

get version(): number

当前版本,每次有数据更新都会增加,可以用作和其他组件合作的依据。

# Returns

number

# Methods

# getData

getData<T>(key): ITickSystemData[T]

获取一个当前值。

# Type parameters

Name Type
T extends never

# Parameters

Name Type
key T

# Returns

ITickSystemData[T]

# Inherited from

Component.getData


# setData

setData(data): void

不通过xml而是直接设置data,注意值的类型需要和schema中一致。

# Parameters

Name Type
data Partial<ITickSystemData>

# Returns

void

# Inherited from

Component.setData


# setDataOne

setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

Name Type
T extends never

# Parameters

Name Type
key T
value ITickSystemData[T]

# Returns

void

# Inherited from

Component.setDataOne