Function useTween

Parameters

• tween: Ref<
      | {
          callbackScope?: any;
          completeDelay?: string
          | number
          | object
          | Function
          | any[];
          delay?: number | Function;
          duration?: number;
          ease?: string | Function;
          easeParams?: any[];
          flipX?: boolean;
          flipY?: boolean;
          hold?: number;
          interpolation?: string | Function;
          loop?: string | number | object | Function | any[];
          loopDelay?: string | number | object | Function | any[];
          onActive?: TweenOnActiveCallback;
          onActiveParams?: any[];
          onComplete?: TweenOnCompleteCallback;
          onCompleteParams?: any[];
          onLoop?: TweenOnLoopCallback;
          onLoopParams?: any[];
          onPause?: TweenOnPauseCallback;
          onPauseParams?: any[];
          onRepeat?: TweenOnRepeatCallback;
          onRepeatParams?: any[];
          onResume?: TweenOnResumeCallback;
          onResumeParams?: any[];
          onStart?: TweenOnStartCallback;
          onStartParams?: any[];
          onStop?: TweenOnStopCallback;
          onStopParams?: any[];
          onUpdate?: TweenOnUpdateCallback;
          onUpdateParams?: any[];
          onYoyo?: TweenOnYoyoCallback;
          onYoyoParams?: any[];
          paused?: boolean;
          persist?: boolean;
          props?: {
              [key: string]: string | number | GetEndCallback | TweenPropConfig;
          };
          repeat?: number;
          repeatDelay?: number;
          yoyo?: boolean;
          [key: string]: any;
      }
      | undefined,
  >
• newTween: {
      callbackScope?: any;
      completeDelay?: string | number | object | Function | any[];
      delay?: number | Function;
      duration?: number;
      ease?: string | Function;
      easeParams?: any[];
      flipX?: boolean;
      flipY?: boolean;
      hold?: number;
      interpolation?: string | Function;
      loop?: string | number | object | Function | any[];
      loopDelay?: string | number | object | Function | any[];
      onActive?: TweenOnActiveCallback;
      onActiveParams?: any[];
      onComplete?: TweenOnCompleteCallback;
      onCompleteParams?: any[];
      onLoop?: TweenOnLoopCallback;
      onLoopParams?: any[];
      onPause?: TweenOnPauseCallback;
      onPauseParams?: any[];
      onRepeat?: TweenOnRepeatCallback;
      onRepeatParams?: any[];
      onResume?: TweenOnResumeCallback;
      onResumeParams?: any[];
      onStart?: TweenOnStartCallback;
      onStartParams?: any[];
      onStop?: TweenOnStopCallback;
      onStopParams?: any[];
      onUpdate?: TweenOnUpdateCallback;
      onUpdateParams?: any[];
      onYoyo?: TweenOnYoyoCallback;
      onYoyoParams?: any[];
      paused?: boolean;
      persist?: boolean;
      props?: {
          [key: string]: string | number | GetEndCallback | TweenPropConfig;
      };
      repeat?: number;
      repeatDelay?: number;
      yoyo?: boolean;
      [key: string]: any;
  }

  • [key: string]: any

  • OptionalcallbackScope?: any

    The scope (or context) for all of the callbacks. The default scope is the tween.

  • OptionalcompleteDelay?: string | number | object | Function | any[]

    The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.

  • Optionaldelay?: number | Function

    The number of milliseconds to delay before the tween will start.

  • Optionalduration?: number

    The duration of the tween in milliseconds.

  • Optionalease?: string | Function

    The easing equation to use for the tween.

  • OptionaleaseParams?: any[]

    Optional easing parameters.

  • OptionalflipX?: boolean

    Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.

  • OptionalflipY?: boolean

    Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.

  • Optionalhold?: number

    The number of milliseconds to hold the tween for before yoyo'ing.

  • Optionalinterpolation?: string | Function

    The interpolation function to use if the value given is an array of numbers.

  • Optionalloop?: string | number | object | Function | any[]

    The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.

  • OptionalloopDelay?: string | number | object | Function | any[]

    The time the tween will pause before starting either a yoyo or returning to the start for a repeat.

  • OptionalonActive?: TweenOnActiveCallback

    A function to call when the tween becomes active within the Tween Manager.

  • OptionalonActiveParams?: any[]

    Additional parameters to pass to onActive.

  • OptionalonComplete?: TweenOnCompleteCallback

    A function to call when the tween completes.

  • OptionalonCompleteParams?: any[]

    Additional parameters to pass to onComplete.

  • OptionalonLoop?: TweenOnLoopCallback

    A function to call each time the tween loops.

  • OptionalonLoopParams?: any[]

    Additional parameters to pass to onLoop.

  • OptionalonPause?: TweenOnPauseCallback

    A function to call when the tween is paused.

  • OptionalonPauseParams?: any[]

    Additional parameters to pass to onPause.

  • OptionalonRepeat?: TweenOnRepeatCallback

    A function to call each time a property tween repeats. Called once per property per target.

  • OptionalonRepeatParams?: any[]

    Additional parameters to pass to onRepeat.

  • OptionalonResume?: TweenOnResumeCallback

    A function to call when the tween is resumed after being paused.

  • OptionalonResumeParams?: any[]

    Additional parameters to pass to onResume.

  • OptionalonStart?: TweenOnStartCallback

    A function to call when the tween starts playback, after any delays have expired.

  • OptionalonStartParams?: any[]

    Additional parameters to pass to onStart.

  • OptionalonStop?: TweenOnStopCallback

    A function to call when the tween is stopped.

  • OptionalonStopParams?: any[]

    Additional parameters to pass to onStop.

  • OptionalonUpdate?: TweenOnUpdateCallback

    A function to call each time the tween steps. Called once per property per target.

  • OptionalonUpdateParams?: any[]

    Additional parameters to pass to onUpdate.

  • OptionalonYoyo?: TweenOnYoyoCallback

    A function to call each time a property tween yoyos. Called once per property per target.

  • OptionalonYoyoParams?: any[]

    Additional parameters to pass to onYoyo.

  • Optionalpaused?: boolean

    Does the tween start in a paused state (true) or playing (false)?

  • Optionalpersist?: boolean

    Will the Tween be automatically destroyed on completion, or retained for future playback?

  • Optionalprops?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }

    The properties to tween.

  • Optionalrepeat?: number

    The number of times each property tween repeats.

  • OptionalrepeatDelay?: number

    The number of milliseconds to pause before a repeat.

  • Optionalyoyo?: boolean

    Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.