Editor Scripting API
    Preparing search index...

    Class Text

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

        const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
        const scene = model.project.scene;

        const obj = scene.createSceneObject('TextObj');
        const text = obj.addComponent('Text') as Editor.Components.Text;

        text.text = 'Hello World';
        text.size = 48;
        text.italic = false;
        text.depthTest = false;
        text.letterSpacing = 0.0;

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    advancedLayout backgroundSettings capitalizationOverride debugRenderLayoutRect depthTest dropshadowSettings editable enabled enableRichText font fontSource horizontalAlignment horizontalOverflow id italic layoutRect letterSpacing lineSpacing meshShadowMode meta name outlineSettings renderOrder sceneObject shadowColor shadowDensity showEditingPreview size sizeToFit stretchMode text textFill touchHandler twoSided type verticalAlignment verticalOverflow weight

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    advancedLayout: TextAdvancedLayout

    Advanced layout configuration for text rendering.

    backgroundSettings: BackgroundSettings

    Background appearance settings for the text.

    capitalizationOverride: CapitalizationOverride

    Override text capitalization style.

    debugRenderLayoutRect: boolean
    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

    If enabled, inputted text will be interpreted as rich text.

    font: Font

    Font asset used for rendering text.

    fontSource: Font | FontCollection | FontFamily

    The font source for this text component. Can be a Font, FontFamily, or FontCollection asset.

    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.

    layoutRect: Editor.Rect
    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

    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.

    Methods

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods