Interface OutlineSettings

Description

Used in Text's outlineSettings property. Configures how text outlining will appear on a Text component.

Example

// @input Component.Text textComponent

var outlineSettings = script.textComponent.outlineSettings;

outlineSettings.enabled = true;
outlineSettings.size = 0.25;
outlineSettings.fill.color = new vec4(0, 0, 1, 1);
interface OutlineSettings {
    enabled: boolean;
    fill: TextFill;
    size: number;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled fill size

Methods

getTypeName isOfType isSame

Properties

enabled

enabled: boolean

Description

Whether outline is enabled on the Text.

fill

fill: TextFill

Description

Settings for how the outline is drawn.

size

size: number

Description

The strength of the outline effect, ranging from 0.0 (no outline) to 1.0 (very strong outline).

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc