Interface JavaScriptAssetBeta

A script asset that is written in JavaScript.

Example

#script-assetshttps://docs.snap.com/lens-studio/5.0.0/essential-skills/scripting/scripting-introduction
interface JavaScriptAsset {
    componentId: Uuid;
    description: string;
    exportId: Uuid;
    fileMeta: AssetImportMetadata;
    icon: Icon;
    id: Uuid;
    name: string;
    type: string;
    version: Version;
    getDirectlyReferencedEntities(): Entity[];
    getOwnedEntities(): Entity[];
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    isScriptInputHidden(inputName: string): boolean;
    remapReferences(referenceMapping: object): void;
    setScriptInputHidden(inputName: string, hidden: boolean): void;
}

Hierarchy (view full)

Properties

componentId description exportId fileMeta icon id name type version

Methods

getDirectlyReferencedEntities getOwnedEntities getTypeName isOfType isSame isScriptInputHidden remapReferences setScriptInputHidden

Properties

Readonly BetacomponentId

componentId: Uuid

Id associated with the script asset.

Betadescription

description: string

Description associated with the script asset

Readonly BetaexportId

exportId: Uuid

Export id associated with the script asset.

Readonly BetafileMeta

fileMeta: AssetImportMetadata

Betaicon

icon: Icon

Icon associated with the script asset.

Readonly Betaid

id: Uuid

The unique id of the entity.

Readonly Betaname

name: string

The name of the asset.

Readonly Betatype

type: string

The entity's type.

Betaversion

version: Version

Version associated with the script asset.

Methods

getDirectlyReferencedEntities

getOwnedEntities

getTypeName

isOfType

  • isOfType(type): boolean
  • Beta

    Parameters

    • type: string

    Returns boolean

isSame

isScriptInputHidden

  • isScriptInputHidden(inputName): boolean
  • Beta

    Returns true if the script inpput is hidden from the scene.

    Parameters

    • inputName: string

    Returns boolean

remapReferences

  • remapReferences(referenceMapping): void
  • Beta

    Swap this entity for another one based on a JSON of the current entity id and the target entity id.

    Parameters

    • referenceMapping: object

    Returns void

setScriptInputHidden

  • setScriptInputHidden(inputName, hidden): void
  • Beta

    Used when you'd like to hide inputs from users in the scene.

    Parameters

    • inputName: string
    • hidden: boolean

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods