Editor Scripting API
    Preparing search index...

    Class OutlineSettings

    Settings for outline rendering on a component.

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

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

        text.text = 'Outlined';
        const outline = text.outlineSettings;
        outline.enabled = true;
        outline.size = 3;
        outline.fill.color = new vec4(1, 0, 0, 1);
        console.log(`OutlineSettings: enabled=${outline.enabled}, size=${outline.size}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    enabled fill id meta size type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    enabled: boolean

    Whether the outline is displayed.

    fill: TextFill

    Texture applied to the outline.

    id: Uuid

    The unique id of the entity.

    meta: Meta

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

    size: number

    Width of the outline in pixels.

    type: string

    The entity's type.

    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