Editor Scripting API
    Preparing search index...

    Class JavaScriptAsset

    A script asset that is written in JavaScript.

    #script-assetshttps://docs.snap.com/lens-studio/5.0.0/essential-skills/scripting/scripting-introduction

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attachments cacheFile componentId declarationFile description exportId fileMeta icon id meta name readMe scriptInputInfo tags type version

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame isScriptInputHidden setScriptInputHidden

    Constructors

    Properties

    attachments: Editor.Assets.Asset[]

    Array of assets attached to this script.

    cacheFile: Path

    Path to the cached asset file.

    componentId: Uuid

    Id associated with the script asset.

    declarationFile: ScriptAsset

    TypeScript declaration file path for this script's type definitions.

    description: string

    Description associated with the script asset

    exportId: Uuid

    Export id associated with the script asset.

    fileMeta: Editor.Model.AssetImportMetadata

    Import metadata for the asset.

    icon: Editor.Icon

    Icon associated with the script asset.

    id: Uuid

    The unique id of the entity.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    The name of the asset.

    readMe: MarkdownAsset

    Documentation string for this script.

    scriptInputInfo: any

    Read-only information about the script's input parameters.

    tags: string[]

    Array of tags categorizing this script.

    type: string

    The entity's type.

    version: Editor.Assets.Version

    Version associated with the script asset.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      • inputName: string

      Returns boolean

    • 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

    Constructors
    Properties
    Methods