Lens Scripting API

    Class VFXAsset

    Defines a VFX to use with VFXComponent.

    VFX guide.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    feedbacks: PassWrappers

    Returns a PassWrapper containing all feedback passes in a VFX asset

    When Mesh is selected as a Geometry Type in the VFX Output Container, the system will render particles using this mesh, otherwise particles will be rendered as quads. Refer to the Custom Mesh Emitter built-in asset as a starting point when working with custom meshes.

    name: string

    The name of the Asset in Lens Studio.

    outputs: PassWrappers

    Returns a PassWrapper containing all output passes in a VFX asset

    properties: Properties

    Controls properties for the VFXAsset. Any scriptable properties on a VFX Graph will automatically become properties of this Properties class. For example, if the VFX Graph defines a variable named baseColor, a script would be able to access that property as vfxAsset.properties.baseColor.

    simulations: PassWrappers

    Returns a PassWrapper containing all simulation passes in a VFX asset

    uniqueIdentifier: string

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    MMNEPVFCICPMFPCPTTAAATR