Lens Scripting API
    Preparing search index...

    Class VFXComponent

    Renders VFXAsset in scene.

    Hierarchy (View Summary)

    Index

    Properties

    asset cullingBoundsSize emitting enabled extentsTarget horizontalAlignment isBeingDestroyed isEnabledInHierarchy meshShadowMode paused renderOrder sceneObject shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment worldBoundsCenter

    Methods

    clear destroy getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin restart setRenderOrder snap time worldAabbMax worldAabbMin

    Properties

    asset: VFXAsset

    The VFXAsset that describes the VFX simulation.

    Lens Scripting Version 147

    null
    cullingBoundsSize: vec3

    Sets the size of the Culling Bounds bounding box When non zero, overrides the static Culling Bounds dimensions from the VFX graph

    Lens Scripting Version 363

    (0, 0, 0)

    //@input Component.VFXComponent vfxComponent

    script.vfxComponent.cullingBoundsSize = new vec3(1.0, 1.0, 1.0);
    emitting: boolean

    Enables or disables emission logic for emitters on this component.

    Lens Scripting Version 296

    true
    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    extentsTarget: ScreenTransform

    When a ScreenTransform is present on this SceneObject, and extentsTarget is a child of this SceneObject, extentsTarget will be repositioned to match the exact area this MeshVisual is being rendered. Very useful for Image and Text components.

    null
    horizontalAlignment: HorizontalAlignment

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.

    HorizontalAlignment.Center
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
        // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    MeshShadowMode.None
    paused: boolean

    When true, stops the VFX simulation by setting delta time to 0.

    Lens Scripting Version 307

    false
    renderOrder: number

    The order in which the visual should be rendered.

    Lens Scripting Version 323

    0
    sceneObject: SceneObject

    The SceneObject this component is on.

    shadowColor: vec4

    Affects the color of shadows being cast by this MeshVisual. The color of the cast shadow is a mix between shadowColor and the material's base texture color. The alpha value of shadowColor controls the mixing of these two colors, with 0 = shadowColor and 1 = shadowColor * textureColor.

    (1, 1, 1, 1)
    shadowDensity: number

    Density of shadows cast by this MeshVisual.

    1
    stretchMode: StretchMode

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be stretched relative to the ScreenTransform's boundaries.

    StretchMode.Stretch
    uniqueIdentifier: string

    Lens Scripting Version 176

    verticalAlignment: VerticalAlignment

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.

    VerticalAlignment.Center
    worldBoundsCenter: vec3

    Sets the world space center of the Culling Bounds for frustum culling.

    Lens Scripting Version 363

    (0, 0, 0)

    //@input Component.VFXComponent vfxComponent
    //@input SceneObject trackedObject

    script.createEvent("UpdateEvent").bind(function() {
        script.vfxComponent.worldBoundsCenter = script.trackedObject.getTransform().getWorldPosition();
    });

    Methods

    • Clear the VFX system.

      Returns void

      Lens Scripting Version 148

    • 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

    • Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Restart the VFX system.

      Returns void

      Lens Scripting Version 179

    • Sets the order of this Visual in the render queue.

      Parameters

      • value: number

      Returns void

    • Projects screen positions from camera's view onto the mesh's UVs. If the MeshVisual's material uses the same texture as the camera input, the MeshVisual will look identical to the part of the screen it covers.

      Parameters

      Returns void

    • Returns the time in seconds since the VFX component was enabled, adjusted by the VFX Asset's delta time configuration. Component Time differs from Elapsed Time in that Elapsed Time is the total time since the Lens started.

      Returns number

      Lens Scripting Version 307

    • Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    • Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

      Lens Scripting Version 156

    Settings

    Member Visibility

    On This Page

    Properties
    Methods