ScriptAsset
ClassRepresents a JavaScript or TypeScript script that can be used to add logic in your Lens.
- Available on all platforms
Since Lens Scripting v176
Index
Properties
Methods
Extends
Properties
name
name:
string
The name of the Asset in Lens Studio.
Default Value
""
Inherited from
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
updateOrder
readonlyupdateOrder: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()
staticgetTypeName():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
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean