Skip to main content

ScriptAsset

Class

Represents a JavaScript or TypeScript script that can be used to add logic in your Lens.

  • 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.

Since Lens Scripting v176

Index

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Asset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier


updateOrder

readonly updateOrder: number

Determines the order in which this script's lifecycle callbacks (onAwake, onStart, onUpdate, onLateUpdate, etc.) fire relative to other scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Defaults to 0. Advisory range: [-1000, +1000]. Immutable at runtime.

Remarks

updateOrder only orders scripts relative to other scripts; it does not affect ordering relative to engine components. Lens Studio provides an Inspector field for editing this at design time.

Since

Lens Scripting Version 367

Example

//@input Asset.ScriptAsset controllerScript
print("controllerScript updateOrder: " + script.controllerScript.updateOrder);

Methods

getTypeName()

static getTypeName(): TypeName<ScriptAsset>

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

Since

Lens Scripting Version 176

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.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

Asset.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

Asset.isSame