Preparing search index...

    3D text rendering component with font, layout, and styling options.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    advancedLayout: TextAdvancedLayout

    Advanced text layout settings.

    capitalizationOverride: CapitalizationOverride

    Text capitalization style override.

    editable: boolean

    Enable editing text content at runtime.

    enableBatching: boolean

    Optimize rendering by batching geometry.

    enabled: boolean

    Whether the component is active.

    enableRichText: boolean
    extrudeDirection: ExtrudeDirection

    Direction to extrude text geometry.

    extrusionDepth: number

    Depth value for text extrusion.

    font: Font

    Font asset used for text rendering.

    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

    Apply italic style to text.

    letterSpacing: number

    Space between individual characters.

    lineSpacing: number

    Space between text lines.

    mainMaterial: Material

    Primary material used for rendering.

    materials: Material[]

    Array of all materials on this mesh visual.

    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.

    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

    Display text editing preview in editor.

    size: number

    Font size in pixels.

    sizeToFit: boolean

    Automatically scale text to fit bounds.

    stretchMode: StretchMode

    How the mesh stretches to fit its container.

    text: string

    Text string content to render.

    touchHandler: InteractionComponent

    Enable touch input handling on text.

    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 in world space.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Move a material from one index to another.

      Parameters

      • origin: number
      • destination: number

      Returns void