Skip to main content

DropshadowSettings

Class

Used in Text's dropShadowSettings 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 dropShadowSettings property. Configures how dropshadow will appear on a Text component.

Index

Example

// @input Component.Text textComponent

var shadowSettings = script.textComponent.dropshadowSettings;

shadowSettings.enabled = true;
shadowSettings.offset = new vec2(0.15, 0.15);

Extends

Properties

enabled

enabled: boolean

Whether dropshadow is enabled on the Text.

Default Value

false

fill

fill: TextFill

Settings for how the inside of the dropshadow is drawn.


offset

offset: vec2

An (x, y) offset controlling where the dropshadow is drawn relative to the Text.

Default Value

(0.25, 0.25)

Methods

getTypeName()

static getTypeName(): TypeName<DropshadowSettings>

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<DropshadowSettings>

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