Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LabelComponent

文字标签组件。 可通过 cc.LabelComponent 获得此组件

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

Protected _N$file

_N$file: Font | null = null

Protected _actualFontSize

_actualFontSize: number = 0

Protected _assembler

_assembler: IAssembler | null = null

Protected _assemblerData

_assemblerData: ISharedLabelData | null = null

Protected _cacheMode

_cacheMode: CacheMode = CacheMode.NONE

Protected _color

_color: Color = Color.WHITE.clone()

Protected _delegateSrc

_delegateSrc: Node | null = null

Protected _dstBlendFactor

_dstBlendFactor: GFXBlendFactor = GFXBlendFactor.ONE_MINUS_SRC_ALPHA

Protected _enableWrapText

_enableWrapText: boolean = true

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

Protected _font

_font: Font | null = null

Protected _fontAtlas

_fontAtlas: FontAtlas | null = null

Protected _fontFamily

_fontFamily: string = "Arial"

Protected _fontSize

_fontSize: number = 40

Protected _horizontalAlign

_horizontalAlign: HorizontalTextAlignment = HorizontalTextAlignment.CENTER

_id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _instanceMaterialType

_instanceMaterialType: InstanceMaterialType = InstanceMaterialType.ADDCOLORANDTEXTURE

Protected _isBold

_isBold: boolean = false

Protected _isItalic

_isItalic: boolean = false

Protected _isSystemFontUsed

_isSystemFontUsed: boolean = true

Protected _isUnderline

_isUnderline: boolean = false

Protected _lastParent

_lastParent: Node | null = null

Protected _letterTexture

_letterTexture: LetterRenderTexture | null = null

Protected _lineHeight

_lineHeight: number = 40

Protected _material

_material: Material | null = null

Protected _name

_name: string

_objFlags

_objFlags: number

Protected _overflow

_overflow: Overflow = Overflow.NONE

Protected _postAssembler

_postAssembler: IAssembler | null = null

Protected _renderData

_renderData: RenderData | null = null

Protected _renderDataFlag

_renderDataFlag: boolean = true

Protected _renderFlag

_renderFlag: boolean = true

sceneGetter

sceneGetter: null | function = null

Protected _sharedMaterial

_sharedMaterial: Material | null = null

Protected _spacingX

_spacingX: number = 0

Protected _srcBlendFactor

_srcBlendFactor: GFXBlendFactor = GFXBlendFactor.SRC_ALPHA

Protected _string

_string: string = "label"

Protected _texture

_texture: SpriteFrame | LetterRenderTexture | null = null

Protected _ttfSpriteFrame

_ttfSpriteFrame: SpriteFrame | null = null

Protected _useOriginalSize

_useOriginalSize: boolean = true

Protected _userDefinedFont

_userDefinedFont: Font | null = null

Protected _verticalAlign

_verticalAlign: VerticalTextAlignment = VerticalTextAlignment.CENTER

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

property

node

type

{Node}

example
cc.log(comp.node);

Static Assembler

Assembler: IAssemblerManager | null = null

Static BlendState

BlendState: GFXBlendFactor = GFXBlendFactor

Static CacheMode

CacheMode: CacheMode = CacheMode

Static HorizontalAlign

HorizontalAlign: HorizontalTextAlignment = HorizontalTextAlignment

Static Overflow

Overflow: Overflow = Overflow

Static PostAssembler

PostAssembler: IAssemblerManager | null = null

Static VerticalAlign

VerticalAlign: VerticalTextAlignment = VerticalTextAlignment

Static _canvasPool

_canvasPool: CanvasPool = new CanvasPool()

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

bmFontOriginalSize

  • get bmFontOriginalSize(): number

isOnLoadCalled

  • get isOnLoadCalled(): number

actualFontSize

  • get actualFontSize(): number
  • set actualFontSize(value: number): void

assemblerData

  • get assemblerData(): null | ISharedLabelData

cacheMode

color

  • get color(): Readonly<Color>
  • set color(value: object): void

delegateSrc

  • set delegateSrc(value: Node): void

dstBlendFactor

enableWrapText

  • get enableWrapText(): boolean
  • set enableWrapText(value: boolean): void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

font

  • get font(): null | Font
  • set font(value: null | Font): void

fontAtlas

  • get fontAtlas(): null | FontAtlas
  • set fontAtlas(value: null | FontAtlas): void

fontFamily

  • get fontFamily(): string
  • set fontFamily(value: string): void

fontSize

  • get fontSize(): number
  • set fontSize(value: number): void

horizontalAlign

isBold

  • get isBold(): boolean
  • set isBold(value: boolean): void

isItalic

  • get isItalic(): boolean
  • set isItalic(value: boolean): void

isUnderline

  • get isUnderline(): boolean
  • set isUnderline(value: boolean): void

isValid

  • get isValid(): boolean

  • 表示该对象是否可用（被 destroy 后将不可用）。
    当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy，请使用 cc.isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    import * as cc from 'cc';
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

lineHeight

  • get lineHeight(): number
  • set lineHeight(value: number): void

material

name

  • get name(): string
  • set name(value: string): void

overflow

renderData

  • get renderData(): null | RenderData

sharedMaterial

  • get sharedMaterial(): null | Material
  • set sharedMaterial(value: null | Material): void

spacingX

  • get spacingX(): number
  • set spacingX(value: number): void

spriteFrame

  • get spriteFrame(): null | SpriteFrame | LetterRenderTexture

srcBlendFactor

string

  • get string(): string
  • set string(value: string): void

useSystemFont

  • get useSystemFont(): boolean
  • set useSystemFont(value: boolean): void

uuid

  • get uuid(): string

verticalAlign

Methods

preload

  • __preload(): void

Protected applyFontTexture

  • applyFontTexture(force: boolean): void

Protected canRender

  • _canRender(): boolean

Protected checkAndUpdateRenderData

  • _checkAndUpdateRenderData(): void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void

  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected flushAssembler

  • _flushAssembler(): void

Protected flushMaterial

  • _flushMaterial(): void

Protected Optional getLocalBounds

  • getLocalBounds(out_rect: Rect): void

  • 如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB）， 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getRenderScene

  • _getRenderScene(): RenderScene

Protected instanceMaterial

  • _instanceMaterial(): void

instantiate

  • instantiate(cloned: any): any

Protected nodeStateChange

onPreDestroy

  • _onPreDestroy(): void

Protected postCanRender

  • _postCanRender(): void

Protected postRender

  • postRender(render: UI): void

Protected render

  • render(render: UI): void

Protected updateBlendFunc

  • _updateBlendFunc(): void

Protected updateColor

  • _updateColor(): void

Protected updateMaterial

  • updateMaterial(material: Material | null): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

destroy

  • destroy(): any

destroyRenderData

  • destroyRenderData(): void

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
var test = node.getComponent("Test");

    Parameters

    • className: string

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

Protected Optional lateUpdate

  • lateUpdate(dt: number): void

  • 如果该组件启用，则每帧调用 LateUpdate。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

markForUpdateRenderData

  • markForUpdateRenderData(enable?: boolean): void

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

  • onLoad(): void

  • 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void

  • onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。 然而，在极端的情况下，它可能无法良好运作。
    那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。 一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的，编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

postUpdateAssembler

  • postUpdateAssembler(render: UI): void

requestRenderData

  • requestRenderData(): RenderData

Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void

  • 调度一个自定义的回调函数。
    如果回调函数已调度，那么将不会重复调度它，只会更新时间间隔参数。

    method

    schedule

    example
    var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

    Parameters

    • callback: any

      回调函数。

    • Default value interval: number = 0

      时间间隔，0 表示每帧都重复。

    • Default value repeat: number = cc.macro.REPEAT_FOREVER

      将被重复执行（repeat+ 1）次，您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。

    • Default value delay: number = 0

      第一次执行前等待的时间（延时执行）。

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void

  • 调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

      第一次执行前等待的时间（延时执行）。

    Returns void

Protected Optional start

  • start(): void

  • 如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Returns void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

Protected Optional update

  • update(dt: number): void

  • 如果该组件启用，则每帧调用 update。
    该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

updateAssembler

  • updateAssembler(render: UI): void

updateRenderData

  • updateRenderData(force?: boolean): void

Static deferredDestroy

  • _deferredDestroy(): void

Object literals

Protected blendTemplate

blendTemplate: object

depthStencilState

depthStencilState: object

Type declaration

rasterizerState

rasterizerState: object

Type declaration

blendState

blendState: object

targets

targets: object[] = [{blendSrc: GFXBlendFactor.SRC_ALPHA,blendDst: GFXBlendFactor.ONE_MINUS_SRC_ALPHA,},]

Generated using TypeDoc