Lens Scripting API

    Type Parameters

    Index

    Constructors

    • Type Parameters

      Parameters

      • object: T

        The object whose properties this Tween will animate.

      • Optionalgroup: default

        The object whose properties this Tween will animate.

      Returns Tween<T>

    • Type Parameters

      Parameters

      • object: T
      • group: true

      Returns Tween<T>

      The group parameter is now deprecated, instead use new Tween(object) then group.add(tween) to add a tween to a group. Use new Tween(object, true) to restore the old behavior for now, but this will be removed in the future.

    Properties

    autoStartOnUpdate: boolean = false

    Methods

    • Parameters

      Returns this

    • Parameters

      • amount: number = 0

      Returns this

    • Parameters

      • duration: number = 1000

      Returns this

    • Parameters

      • dynamic: boolean = false

      Returns this

    • Returns this

    • Returns number

    • Returns number

    • Removes the tween from the current group it is in, if any, then adds the tween to the specified group.

      Parameters

      Returns this

    • Returns this

      The argless call signature has been removed. Use tween.group(group) or group.add(tween), instead.

    • Returns boolean

    • Returns boolean

    • Parameters

      • Optionalcallback: (object: T) => void

      Returns this

    • Parameters

      • Optionalcallback: (object: T) => void

      Returns this

    • Parameters

      • Optionalcallback: (object: T) => void

      Returns this

    • Parameters

      • Optionalcallback: (object: T) => void

      Returns this

    • Parameters

      • Optionalcallback: (object: T) => void

      Returns this

    • Parameters

      • Optionalcallback: (object: T, elapsed: number) => void

      Returns this

    • Parameters

      • time: number = ...

      Returns this

    • Removes the tween from whichever group it is in.

      Returns Tween<T>

    • Parameters

      • times: number = 0

      Returns this

    • Parameters

      • Optionalamount: number

      Returns this

    • Parameters

      • time: number = ...

      Returns this

    • Parameters

      • time: number = ...
      • overrideStartingValues: boolean = false

      Returns this

    • Parameters

      • Optionaltime: number

      Returns this

    • Returns this

    • Returns this

    • Parameters

      • time: number = ...
      • autoStart: boolean = Tween.autoStartOnUpdate

        When true, calling update will implicitly call start() as well. Note, if you stop() or end() the tween, but are still calling update(), it will start again!

      Returns boolean

      true if the tween is still playing after the update, false otherwise (calling update on a paused tween still returns true because it is still playing, just paused).

    • Parameters

      • yoyo: boolean = false

      Returns this

    MMNEPVFCICPMFPCPTTAAATR