#类TextComponent

继承自	TextComponentBase, MaskableGraphic
实现了	ITextComponent

@since

2.0.0

总览

属性

#Pdefination

存储需要序列化的数据

签名	Record<string, any>

#PeffectScaleX受保护

描边/阴影等特效导致的纹理扩容比例 X/Y

签名	number

#Pitem继承自 MaskableGraphic.item

附加到的 VFXItem 对象

签名	VFXItem

#PlineCount继承自 TextComponentBase.lineCount

文本行数

#PmaxLineWidth受保护继承自 TextComponentBase.maxLineWidth

每一行文本的最大宽度

#PmeshCollider受保护

用于点击测试的碰撞器

签名	MeshCollider

访问器

#Acolor

签名

GETcolor(): Color

描述

获取当前图层的颜色

@since

2.5.0

返回 Color

签名

SETcolor(value: Color): void

描述

设置当前图层的颜色

@since

2.5.0

参数

value: Color

返回 void

#AisActiveAndEnabled

签名

GETisActiveAndEnabled(): boolean

描述

组件是否可以更新，true 更新，false 不更新

返回 boolean

#Atransform

签名

GETtransform(): Transform

描述

附加到的 VFXItem 对象 Transform 组件

返回 Transform

方法

#Mdispose

签名

dispose(): void

描述

销毁当前对象

返回 void

#MgetEffectPadding受保护

签名

getEffectPadding(): { 
        padB: number; 
        padL: number; 
        padR: number; 
        padT: number; 
}

描述

获取描边和阴影的 padding 值（单位：px）

@returns

返回 {
padB: number;
padL: number;
padR: number;
padT: number;
}

#MgetInstanceId

签名

getInstanceId(): string

描述

@returns

返回 string

#MgetTextureExpandScale

签名

getTextureExpandScale(): [ number, number ]

描述

给渲染层用：获取特效扩容比例（描边/阴影导致的纹理扩容）

@returns

返回 [ number, number ]

#MgetVisible

签名

getVisible(): boolean

描述

获取当前 Mesh 的可见性。

@deprecated

2.4.0 Please use enabled instead

返回 boolean

#MonApplyAnimationProperties

签名

onApplyAnimationProperties(): void

描述

当属性被动画修改时调用

返回 void

#MonAwake

签名

onAwake(): void

描述

生命周期函数，初始化后调用，生命周期内只调用一次

返回 void

#MonDestroy

签名

onDestroy(): void

描述

生命周期函数，在组件销毁时调用

返回 void

#MonDisable

签名

onDisable(): void

描述

在 enabled 变为 false 时触发

返回 void

#MonEnable

签名

onEnable(): void

描述

在 enabled 变为 true 时触发

返回 void

#MonLateUpdate

签名

onLateUpdate(dt: number): void

描述

生命周期函数，每帧调用一次，在 update 之后调用

参数

dt: number

返回 void

#MonStart

签名

onStart(): void

描述

生命周期函数，在第一次 update 前调用，生命周期内只调用一次

返回 void

#MrenderToTexture受保护继承自 TextComponentBase.renderToTexture

#MsetColor

签名

setColor(color: Color): void

描述

设置当前图层的颜色

Tips: 透明度也属于颜色的一部分，当有透明度/颜色 K 帧变化时，该 API 会失效

@since

2.4.0

参数

color: Color

颜色值

返回 void

签名

setColor(color: vec4): void

描述

设置当前图层的颜色

Tips: 透明度也属于颜色的一部分，当有透明度/颜色 K 帧变化时，该 API 会失效

@since

2.0.0

参数

color: vec4

颜色值

返回 void

#MsetFontScale继承自 TextComponentBase.setFontScale

#MsetFontStyle继承自 TextComponentBase.setFontStyle

#MsetFontWeight继承自 TextComponentBase.setFontWeight

#MsetInstanceId

签名	`setInstanceId(guid: string): void`
参数	guid: string
返回	void

#MsetLineHeight

签名

setLineHeight(value: number): void

描述

设置行高行高表示每行占用的总高度

参数

value: number

行高像素值

返回 void

#MsetOutlineColor继承自 TextComponentBase.setOutlineColor

#MsetOutlineEnabled继承自 TextComponentBase.setOutlineEnabled

#MsetTextAlign继承自 TextComponentBase.setTextAlign

#MsetTextBaseline继承自 TextComponentBase.setTextBaseline

#MsetTextColor继承自 TextComponentBase.setTextColor

#MsetTextHeight

签名

setTextHeight(value: number): void

描述

设置文本框高度

参数

value: number

文本框高度

返回 void

#MsetTexture

签名

setTexture(input: Texture): void

描述

使用纹理对象设置当前 Mesh 的纹理

@since

2.0.0

参数

input: Texture

纹理对象

返回 void

签名

setTexture(input: string): Promise<void>

描述

使用资源链接异步设置当前 Mesh 的纹理

@since

2.3.0

参数

input: string

资料链接

返回 Promise<void>

#MsetTextWidth

签名

setTextWidth(value: number): void

描述

设置文本框宽度手动设置宽度时会自动关闭 autoWidth 同时会按比例更新 transform.size.x，让 UI 框宽度也跟着变化

参数

value: number

文本框宽度

返回 void

#MsetVisible

签名

setVisible(visible: boolean): void

描述

设置当前 Mesh 的可见性。

@deprecated

2.4.0 Please use enabled instead

参数

visible: boolean

true：可见，false：不可见

返回 void

#MtoData

签名	`toData(): void`
返回	void

#MupdateTexture受保护

签名

updateTexture(flipY: boolean): void

描述

更新文本

@returns

参数

flipY: boolean

返回 void

#MupdateWithOptions

签名

updateWithOptions(options: TextContentOptions): void

描述

根据配置更新文本样式和布局

参数

options: TextContentOptions

返回 void

#Mis静态

签名

is(obj: unknown): obj is EffectsObject

描述

@returns

参数

obj: unknown

返回 obj is EffectsObject