Lens Scripting API
    Index

    Methods

    • Parameters

      • material: Material

        Material that you wish to change alpha

      • from: number

        Initial value of your alpha

      • to: number

        Destination value you want your alpha to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ a: number }>

      LSTween.alphaFromTo(material, 0.0, 0.5, 1000.0).start();
      
    • Parameters

      • material: Material

        Material that you wish to change alpha

      • to: number

        Destination value you want your alpha to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ a: number }>

      LSTween.alphaTo(material, 0.25, 1000.0).start();
      
    • Parameters

      • material: Material

        Material that you wish to change color

      • from: vec4

        Initial value of your color

      • to: vec4

        Destination value you want your color to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.colorFromTo(material, new vec4(0,0,0,1), new vec4(0,1,0,1), 1000.0).start();
      
    • Parameters

      • text: Text

        Text that you wish to change color

      • from: vec4

        Initial value of your color

      • to: vec4

        Destination value you want your color to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.colorTextFromTo(text, new vec4(0,0,0,1), new vec4(0,1,0,1), 1000.0).start();
      
    • Parameters

      • text: Text

        Text that you wish to change color

      • to: vec4

        Destination value you want your color to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.colorTextTo(text, new vec4(0,1,0,1), 1000.0).start();
      
    • Parameters

      • material: Material

        Material that you wish to change color

      • to: vec4

        Destination value you want your color to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.colorTo(material, new vec4(0,1,0,1), 1000.0).start();
      
    • Parameters

      • sceneObject: SceneObject

        SceneObject you want to change enabled state

      • endValue: boolean

        End value of enabled state

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<any>

      LSTween.enableChange(sceneObject, false, 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change position

      • from: vec3

        Initial position you want your object to start from

      • to: vec3

        Destination position you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.moveFromToLocal(transform, new vec3(0,0,0), new vec3(0,5,0), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change position

      • from: vec3

        Initial position you want your object to start from

      • to: vec3

        Destination position you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.moveFromToWorld(transform, new vec3(0,0,0), new vec3(0,5,0), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change position

      • offset: vec3

        This is an addition operation in local space. For example, passing new vec3(1,0,0) will make object move 1 unit in X from its start position

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.moveOffset(transform, new vec3(0,5,0), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change position

      • to: vec3

        Destination position you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.moveToLocal(transform, new vec3(0,5,0), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change position

      • to: vec3

        Destination position you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.moveToWorld(transform, new vec3(0,5,0), 1000.0).start();
      
    • Parameters

      • time: number

        Duration of Tween in miliseconds

      Returns Tween

      LSTween.rawTween(1000)
      .onUpdate(function (o) {
      print(o.t);
      })
      .start();
    • Parameters

      • transform: Transform

        Transform object you want to change rotation

      • from: quat

        Initial quaternion you want your object to start from

      • to: quat

        Destination quaternion you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      • interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP

        The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp

      Returns Tween<{ t: number }>

      LSTween.rotateFromToLocal(transform, quat.angleAxis(startRadian, axis), quat.angleAxis(destRadian, axis), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change rotation

      • from: quat

        Initial quaternion you want your object to start from

      • to: quat

        Destination quaternion you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      • interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP

        The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp

      Returns Tween<{ t: number }>

      LSTween.rotateFromToWorld(transform, quat.angleAxis(startRadian, axis), quat.angleAxis(destRadian, axis), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change rotation

      • offset: quat

        Multiplies the offset value from current rotation

      • time: number

        Duration of Tween in miliseconds

      • interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP

        The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp

      Returns Tween<{ t: number }>

      LSTween.rotateOffset(transform, quat.angleAxis(radians, axis), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change rotation

      • to: quat

        Destination quaternion you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      • interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP

        The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp

      Returns Tween<{ t: number }>

      LSTween.rotateToLocal(transform, quat.angleAxis(radians, axis), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change rotation

      • to: quat

        Destination quaternion you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      • interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP

        The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp

      Returns Tween<{ t: number }>

      LSTween.rotateToWorld(transform, quat.angleAxis(radians, axis), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change scale

      • from: vec3

        Initial scale you want your object to start from

      • to: vec3

        Destination scale you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.scaleFromToLocal(transform, new vec3(1,1,1), new vec3(2,2,2), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change scale

      • from: vec3

        Initial scale you want your object to start from

      • to: vec3

        Destination scale you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.scaleFromToWorld(transform, new vec3(1,1,1), new vec3(2,2,2), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change scale

      • offset: vec3

        Multiplies the offset value from current scale

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.scaleOffset(transform, new vec3(2,2,2), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change scale

      • to: vec3

        Destination scale you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.scaleToLocal(transform, new vec3(2,2,2), 1000.0).start();
      
    • Parameters

      • transform: Transform

        Transform object you want to change scale

      • to: vec3

        Destination scale you want your object to go to

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.scaleToWorld(transform, new vec3(2,2,2), 1000.0).start();
      
    • Parameters

      • pass: Pass

        The pass you want to change the property of

      • property: string

        The property name in the pass you want to change

      • from: vec4

        Initial value of your property

      • to: vec4

        Destination value you want your property to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.shaderColorPropertyFromTo(pass, "tintColor", new vec4(0,0,0,1), new vec4(1,1,1,1), 1000.0).start();
      
    • Parameters

      • pass: Pass

        The pass you want to change the property of

      • property: string

        The property name in the pass you want to change

      • from: number

        Initial value of your property

      • to: number

        Destination value you want your property to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ t: number }>

      LSTween.shaderFloatPropertyFromTo(pass, "opacity", 0.0, 1.0, 1000.0).start();
      
    • Parameters

      • text: Text

        Text that you wish to change alpha

      • from: number

        Initial value of your alpha

      • to: number

        Destination value you want your alpha to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ a: number }>

      LSTween.textAlphaFromTo(text, 0.0, 0.5, 1000.0).start();
      
    • Parameters

      • text: Text

        Text that you wish to change alpha

      • to: number

        Destination value you want your alpha to reach

      • time: number

        Duration of Tween in miliseconds

      Returns Tween<{ a: number }>

      LSTween.textAlphaTo(text, 0.25, 1000.0).start();
      
    MMNEPVFCICPMFPCPTTAAATR