Class Text

文本组件

用于显示文字。

Hierarchy

  • Component2D
    • Text

Constructors

Properties

_canvas: HTMLCanvasElement
_entity: Entity
_invalid: boolean = true
_uvRect: Vector4 = ...

显示图片的区域,(0, 0, 1, 1)表示完整显示图片。

autoSize: boolean = true

是否根据文本自动调整宽高。

enabled: boolean = true

是否启用update方法

hideFlags: HideFlags = HideFlags.None

隐藏标记,用于控制是否在层级界面、检查器显示,是否保存

runEnvironment: RunEnvironment = RunEnvironment.all

可运行环境

text: string = 'Hello 🌷 world\nHello 🌷 world'

文本内容。

Accessors

  • get entity(): Entity
  • 此组件附加到的游戏对象。组件总是附加到游戏对象上。

    Returns Entity

  • get isVisibleAndEnabled(): boolean
  • Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

    Returns boolean

Methods

  • Adds a component class of type componentType to the game object.

    Returns

    被添加的组件。

    Type Parameters

    Parameters

    • type: K

      组件类定义。

    Returns ComponentMap[K]

  • 返回游戏对象附加的一个指定类型的组件,如果没有,则返回 null。

    使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件,请改用 Entity.GetComponents,并循环通过返回的组件测试某些唯一属性。

    Returns

    要检索的组件。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    Returns ComponentMap[K]

  • 使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

    Returns

    匹配类型的组件(如果找到)。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

  • 检索 Entity 或其任何父项type中的 Type 组件。

    此方法向上递归,直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

    Returns

    如果找到与类型匹配的组件,则返回一个组件。否则返回 null。

    Type Parameters

    Parameters

    • component: K

      要查找的组件类型。

    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

  • 返回Entity中指定类型的所有组件。

    Returns

    实体中指定类型的所有组件。

    Type Parameters

    Parameters

    • type: K

      要检索的组件类型。

    • results: ComponentMap[K][] = []

      列出接收找到的组件。

    Returns ComponentMap[K][]

  • 使用深度优先搜索返回 当前实体 或其任何子子项中 Type 的所有组件。递归工作。

    在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体,以及所有后续子实体。

    Returns

    所有找到的组件。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    • includeInactive: boolean = false

      非活动游戏对象上的组件是否应该包含在搜索结果中?

    • results: ComponentMap[K][] = []

      列出接收找到的组件。

    Returns ComponentMap[K][]

  • 返回当前实体或其任何父级中指定的所有组件。

    Returns

    实体或其任何父级中指定的所有组件。

    Type Parameters

    Parameters

    • component: K

      要检索的组件类型。

    • includeInactive: boolean = false

      非活动组件是否应该包含在搜索结果中?

    • results: ComponentMap[K][] = []

      列出找到的组件。

    Returns ComponentMap[K][]

  • 初始化组件

    在添加到Entity时立即被调用。

    Returns void

  • Private

    该方法仅在Entity中使用

    Parameters

    Returns void

  • Private

    组件无法直接使用关键字 new 来构造。

    Returns

    新建的组件实例。

    See

    getInstance

    Type Parameters

    • T

    Parameters

    Returns T

Generated using TypeDoc