Skip to content
本页内容

Class: UITextField

组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。

Hierarchy

Properties

Accessors

Methods

Constructors

Properties

object3D

object3D: Object3D = null

此组件附加到的Object3D对象。

Inherited from

UIComponentBase.object3D

Defined in

src/engine/components/ComponentBase.ts:14


serializeTag

Optional serializeTag: SerializeTag

Inherited from

UIComponentBase.serializeTag

Defined in

src/engine/components/ComponentBase.ts:30

Accessors

transform

get transform(): Transform

附加到此 Object3D对象 的 Transform组件。

Returns

Transform

Inherited from

UIComponentBase.transform

Defined in

src/engine/components/ComponentBase.ts:39


enable

get enable(): boolean

启用/禁用 组件。启用的组件可更新,禁用的组件不可更新。

Returns

boolean

Inherited from

UIComponentBase.enable

Defined in

src/engine/components/ComponentBase.ts:62

set enable(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

UIComponentBase.enable

Defined in

src/engine/components/ComponentBase.ts:43


uiTransform

get uiTransform(): UITransform

Returns

UITransform

Inherited from

UIComponentBase.uiTransform

Defined in

src/engine/gui/components/UIComponentBase.ts:6


originSize

get originSize(): number

Returns

number

Defined in

src/engine/gui/components/UITextField.ts:32


font

get font(): string

Returns

string

Defined in

src/engine/gui/components/UITextField.ts:36

set font(value): void

Parameters

NameType
valuestring

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:40


fontSize

get fontSize(): number

Returns

number

Defined in

src/engine/gui/components/UITextField.ts:44

set fontSize(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:48


text

get text(): string

Returns

string

Defined in

src/engine/gui/components/UITextField.ts:55

set text(value): void

Parameters

NameType
valuestring

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:59


color

get color(): Color

Returns

Color

Defined in

src/engine/gui/components/UITextField.ts:101

set color(value): void

Parameters

NameType
valueColor

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:105


alignment

get alignment(): TextAnchor

Returns

TextAnchor

Defined in

src/engine/gui/components/UITextField.ts:113

set alignment(value): void

Parameters

NameType
valueTextAnchor

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:117


lineSpacing

get lineSpacing(): number

Returns

number

Defined in

src/engine/gui/components/UITextField.ts:124

set lineSpacing(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/engine/gui/components/UITextField.ts:128

Methods

onVisible

onVisible(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

UIComponentBase.onVisible

Defined in

src/engine/components/ComponentBase.ts:66


onUpdate

onUpdate(call): void

添加更新函数。会在每帧更新时执行。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIComponentBase.onUpdate

Defined in

src/engine/components/ComponentBase.ts:135


onLateUpdate

onLateUpdate(call): void

添加延迟更新函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIComponentBase.onLateUpdate

Defined in

src/engine/components/ComponentBase.ts:148


onBeforeUpdate

onBeforeUpdate(call): void

添加帧更新前执行的函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIComponentBase.onBeforeUpdate

Defined in

src/engine/components/ComponentBase.ts:161


serialization

serialization(assets): SerializeComponentBase

Parameters

NameType
assetsISerializeAssetsCollect

Returns

SerializeComponentBase

Inherited from

UIComponentBase.serialization

Defined in

src/engine/components/ComponentBase.ts:170


unSerialization

unSerialization(componentData, data): void

Parameters

NameType
componentDataSerializeComponentBase
dataUnSerializeData

Returns

void

Inherited from

UIComponentBase.unSerialization

Defined in

src/engine/components/ComponentBase.ts:175


destroy

destroy(): void

移除组件时候调用

Returns

void

Inherited from

UIComponentBase.destroy

Defined in

src/engine/gui/components/UIComponentBase.ts:23


addQuad

addQuad(quad): void

Parameters

NameType
quadGUIQuad

Returns

void

Inherited from

UIComponentBase.addQuad

Defined in

src/engine/gui/components/UIComponentBase.ts:28


cloneTo

cloneTo(obj): void

创建新的组件,复制当前组件的属性,并添加到目标对象上。

Parameters

NameTypeDescription
objObject3D源对象

Returns

void

Overrides

UIComponentBase.cloneTo

Defined in

src/engine/gui/components/UITextField.ts:21


clean

clean(): void

Returns

void

Overrides

UIComponentBase.clean

Defined in

src/engine/gui/components/UITextField.ts:67

Constructors

constructor

new UITextField()

Overrides

UIComponentBase.constructor

Defined in

src/engine/gui/components/UITextField.ts:17