Skip to main content

VFXComponent

Class

Renders VFXAsset in scene.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Extends

Properties

asset

asset: VFXAsset

The VFXAsset that describes the VFX simulation.

Since

Lens Scripting Version 147

Default Value

null

cullingBoundsSize

cullingBoundsSize: vec3

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

Since

Lens Scripting Version 363

Default Value

(0, 0, 0)

Example

//@input Component.VFXComponent vfxComponent

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

emitting

emitting: boolean

Enables or disables emission logic for emitters on this component.

Since

Lens Scripting Version 296

Default Value

true

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

Default Value

true

Inherited from

BaseMeshVisual.enabled


extentsTarget

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.

Default Value

null

Inherited from

BaseMeshVisual.extentsTarget


horizontalAlignment

horizontalAlignment: HorizontalAlignment

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

Default Value

HorizontalAlignment.Center

Inherited from

BaseMeshVisual.horizontalAlignment


isBeingDestroyed

readonly 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.

Since

Lens Scripting Version 364

Example

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

Inherited from

BaseMeshVisual.isBeingDestroyed


isEnabledInHierarchy

readonly isEnabledInHierarchy: boolean

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

Inherited from

BaseMeshVisual.isEnabledInHierarchy


meshShadowMode

meshShadowMode: MeshShadowMode

None = 0, Caster = 1, Receiver = 2

Default Value

MeshShadowMode.None

Inherited from

BaseMeshVisual.meshShadowMode


paused

paused: boolean

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

Since

Lens Scripting Version 307

Default Value

false

renderOrder

renderOrder: number

The order in which the visual should be rendered.

Since

Lens Scripting Version 323

Default Value

0

Inherited from

BaseMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

The SceneObject this component is on.

Inherited from

BaseMeshVisual.sceneObject


shadowColor

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.

Default Value

(1, 1, 1, 1)

Inherited from

BaseMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Density of shadows cast by this MeshVisual.

Default Value

1

Inherited from

BaseMeshVisual.shadowDensity


stretchMode

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.

Default Value

StretchMode.Stretch

Inherited from

BaseMeshVisual.stretchMode


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

BaseMeshVisual.uniqueIdentifier


verticalAlignment

verticalAlignment: VerticalAlignment

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

Default Value

VerticalAlignment.Center

Inherited from

BaseMeshVisual.verticalAlignment


worldBoundsCenter

worldBoundsCenter: vec3

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

Since

Lens Scripting Version 363

Default Value

(0, 0, 0)

Example

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

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

Methods

clear()

clear(): void

Destroys the simulation and sets asset to null.

Returns

void

Since

Lens Scripting Version 148


destroy()

destroy(): void

Destroys the component.

Returns

void

Inherited from

BaseMeshVisual.destroy


getRenderOrder()

getRenderOrder(): number

Returns the order of this Visual in the render queue.

Returns

number

Inherited from

BaseMeshVisual.getRenderOrder


getSceneObject()

getSceneObject(): SceneObject

Returns the SceneObject the component is attached to.

Returns

SceneObject

Inherited from

BaseMeshVisual.getSceneObject


getTransform()

getTransform(): Transform

Returns the Transform this component is attached to.

Returns

Transform

Inherited from

BaseMeshVisual.getTransform


getTypeName()

static getTypeName(): TypeName<VFXComponent>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<VFXComponent>

Overrides

BaseMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseMeshVisual.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

BaseMeshVisual.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

BaseMeshVisual.isSame


localAabbMax()

localAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

BaseMeshVisual.localAabbMax


localAabbMin()

localAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

BaseMeshVisual.localAabbMin


restart()

restart(): void

Restart the VFX system.

Returns

void

Since

Lens Scripting Version 179


setRenderOrder()

setRenderOrder(value): void

Sets the order of this Visual in the render queue.

Parameters

ParameterType
valuenumber

Returns

void

Inherited from

BaseMeshVisual.setRenderOrder


snap()

snap(camera): 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

ParameterType
cameraCamera

Returns

void

Inherited from

BaseMeshVisual.snap


time()

time(): number

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

Since

Lens Scripting Version 307


worldAabbMax()

worldAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

BaseMeshVisual.worldAabbMax


worldAabbMin()

worldAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156

Inherited from

BaseMeshVisual.worldAabbMin