Preparing search index...

    Renders and manages text in the scene with customizable font, size, layout, and visual effects.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    advancedLayout: TextAdvancedLayout

    Advanced layout configuration for text rendering.

    backgroundSettings: BackgroundSettings

    Background appearance settings for the text.

    capitalizationOverride: CapitalizationOverride

    Override text capitalization style.

    depthTest: boolean

    Enable or disable depth testing for text rendering.

    dropshadowSettings: DropshadowSettings

    Drop shadow effect settings for the text.

    editable: boolean

    Enable or disable text editing in preview mode.

    enabled: boolean

    Whether the component is active.

    enableRichText: boolean
    font: Font

    Font asset used for rendering text.

    horizontalAlignment: Horizontal

    Horizontal alignment of the mesh visual.

    horizontalOverflow: HorizontalOverflow

    Behavior when text exceeds horizontal bounds.

    id: Uuid

    The unique id of the entity.

    italic: boolean

    Enable or disable italic text styling.

    letterSpacing: number

    Spacing between individual characters.

    lineSpacing: number

    Spacing between text lines.

    meshShadowMode: MeshShadowMode

    Shadow rendering mode for the mesh.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    Name of the component.

    outlineSettings: OutlineSettings

    Text outline effect settings.

    renderOrder: number

    Determines the order in which this visual component is rendered relative to others.

    sceneObject: SceneObject

    Scene object this component is attached to.

    shadowColor: vec4

    Color of the mesh shadow.

    shadowDensity: number

    Opacity of the mesh shadow.

    showEditingPreview: boolean

    Show the text editing preview in the editor.

    size: number

    Font size in units.

    sizeToFit: boolean

    Automatically scale text to fit bounds.

    stretchMode: StretchMode

    How the mesh stretches to fit its container.

    text: string

    The text string to render.

    textFill: TextFill

    Text color and fill settings.

    touchHandler: InteractionComponent

    Enable or disable touch interaction for text.

    twoSided: boolean

    Render text on both sides of the plane.

    type: string

    The entity's type.

    verticalAlignment: Vertical

    Vertical alignment of the mesh visual.

    verticalOverflow: VerticalOverflow

    Behavior when text exceeds vertical bounds.

    weight: number

    Font weight value.

    worldSpaceRect: Editor.Rect

    Bounding rectangle of the text in world space.

    Methods

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean