Skip to main content

OutlineSettings

Class

Used in Text's outlineSettings property.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

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

Index

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);

Extends

Properties

enabled

enabled: boolean

Whether outline is enabled on the Text.

Default Value

false

fill

fill: TextFill

Settings for how the outline is drawn.


size

size: number

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

Default Value

0.25

Methods

getTypeName()

static getTypeName(): TypeName<OutlineSettings>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<OutlineSettings>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame