Editor Scripting API
    Preparing search index...

    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

    Properties

    attachments: Editor.Assets.Asset[]
    cacheFile: Path
    componentId: Uuid

    Id associated with the script asset.

    description: string

    Description associated with the script asset

    exportId: Uuid

    Export id associated with the script asset.

    icon: Editor.Icon

    Icon associated with the script asset.

    id: Uuid

    The unique id of the entity.

    meta: Meta
    name: string

    The name of the asset.

    scriptInputInfo: any
    tags: string[]
    type: string

    The entity's type.

    version: Version

    Version associated with the script asset.

    Methods

    • 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