# Interface: PixiVNJsonAnimateBaseOptions (/pixi-vn-json/index/interfaces/PixiVNJsonAnimateBaseOptions)



Defined in: [src/schema/PixiVNJsonCanvasAnimate.ts:14](https://github.com/DRincs-Productions/pixi-vn-json/blob/0b113d798f5dcc85b78953dd2d5f2d71d01ff43a/src/schema/PixiVNJsonCanvasAnimate.ts#L14)

Additional options controlling the animation (duration, easing, repeat, etc.).

## Extends [#extends]

* [`AnimationOptions`](/pixi-vn-json/docs-entry/type-aliases/AnimationOptions)

## Properties [#properties]

### aliasToRemoveAfter? [#aliastoremoveafter]

\> `optional` **aliasToRemoveAfter?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/tickers.d.ts:464

An array of strings containing the aliases of the canvas components to remove after the animation completes.

#### Default [#default]

```ts
[]
```

#### Inherited from [#inherited-from]

`AnimationOptions.aliasToRemoveAfter`

***

### autoplay? [#autoplay]

\> `optional` **autoplay?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2528

#### Inherited from [#inherited-from-1]

`AnimationOptions.autoplay`

***

### bounce? [#bounce]

\> `optional` **bounce?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2351

`bounce` determines the "bounciness" of a spring animation.

`0` is no bounce, and `1` is extremely bouncy. Negative values, down to
`-1`, make an overdamped spring that starts quicker and eases more
gently into its target.

If `duration` is set, this defaults to `0.25`.

Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.

#### Inherited from [#inherited-from-2]

`AnimationOptions.bounce`

***

### bounceDamping? [#bouncedamping]

\> `optional` **bounceDamping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2425

If `min` or `max` is set, this affects the damping of the bounce spring.
If set to `0`, spring will oscillate indefinitely. Set to `10` by
default.

#### Inherited from [#inherited-from-3]

`AnimationOptions.bounceDamping`

***

### bounceStiffness? [#bouncestiffness]

\> `optional` **bounceStiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2417

If `min` or `max` is set, this affects the stiffness of the bounce
spring. Higher values will create more sudden movement. Set to `500` by
default.

#### Inherited from [#inherited-from-4]

`AnimationOptions.bounceStiffness`

***

### completeOnContinue? [#completeoncontinue]

\> `optional` **completeOnContinue?**: `boolean`

Defined in: node_modules/@drincs/pixi-vn/dist/tickers.d.ts:485

A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
When true, calling `narration.continue()` forces the current content to complete before advancing to the next narrative step.

#### Default [#default-1]

```ts
false
```

#### Inherited from [#inherited-from-5]

`AnimationOptions.completeOnContinue`

***

### damping? [#damping]

\> `optional` **damping?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2371

Strength of opposing force. If set to 0, spring will oscillate
indefinitely. Set to `10` by default.

#### Default [#default-2]

```ts
10

@public
```

#### Inherited from [#inherited-from-6]

`AnimationOptions.damping`

***

### delay? [#delay]

\> `optional` **delay?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2717

#### Inherited from [#inherited-from-7]

`AnimationOptions.delay`

***

### delayChildren? [#delaychildren]

\> `optional` **delayChildren?**: `number` | `DynamicOption`\<`number`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2467

When using variants, children animations will start after this duration
(in seconds). You can add the `transition` property to both the `motion.div` and the
`variant` directly. Adding it to the `variant` generally offers more flexibility,
as it allows you to customize the delay per visual state.

#### Inherited from [#inherited-from-8]

`AnimationOptions.delayChildren`

***

### driver? [#driver]

\> `optional` **driver?**: `Driver`

Defined in: node_modules/motion-dom/dist/index.d.ts:2513

#### Inherited from [#inherited-from-9]

`AnimationOptions.driver`

***

### duration? [#duration]

\> `optional` **duration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2527

The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.

#### Inherited from [#inherited-from-10]

`AnimationOptions.duration`

***

### ease? [#ease]

\> `optional` **ease?**: `Easing` | `Easing`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2498

#### Inherited from [#inherited-from-11]

`AnimationOptions.ease`

***

### elapsed? [#elapsed]

\> `optional` **elapsed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2512

The duration of time already elapsed in the animation. Set to `0` by
default.

#### Inherited from [#inherited-from-12]

`AnimationOptions.elapsed`

***

### from? [#from]

\> `optional` **from?**: `any`

Defined in: node_modules/motion-dom/dist/index.d.ts:2530

#### Inherited from [#inherited-from-13]

`AnimationOptions.from`

***

### inherit? [#inherit]

\> `optional` **inherit?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2537

If true, this transition will shallow-merge with its parent transition
instead of replacing it. Inner keys win.

#### Inherited from [#inherited-from-14]

`AnimationOptions.inherit`

***

### isSync? [#issync]

\> `optional` **isSync?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2269

#### Inherited from [#inherited-from-15]

`AnimationOptions.isSync`

***

### mass? [#mass]

\> `optional` **mass?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2380

Mass of the moving object. Higher values will result in more lethargic
movement. Set to `1` by default.

#### Default [#default-3]

```ts
1

@public
```

#### Inherited from [#inherited-from-16]

`AnimationOptions.mass`

***

### max? [#max]

\> `optional` **max?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2437

Maximum constraint. If set, the value will "bump" against this value (or immediately snap to it, if the initial animation value exceeds this value).

#### Inherited from [#inherited-from-17]

`AnimationOptions.max`

***

### min? [#min]

\> `optional` **min?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2431

Minimum constraint. If set, the value will "bump" against this value (or immediately spring to it if the animation starts as less than this value).

#### Inherited from [#inherited-from-18]

`AnimationOptions.min`

***

### mixer? [#mixer]

\> `optional` **mixer?**: (`from`, `to`) => `Mixer`\<`any`> | `undefined`

Defined in: node_modules/motion-dom/dist/index.d.ts:2601

Replaces the function that blends between each pair of keyframes
that aren't numbers. It receives the two keyframes and returns a
function that maps progress (`0`-`1`, or beyond with springs and
overshooting easing) to a value, or `undefined` to blend them as
usual. For example, a mixer that morphs paths can animate `d`
between paths of different shapes, and return `undefined` for values
that aren't paths, like `fill`, so they blend as usual:

```jsx
<motion.path animate={{ d, fill }} transition={{ mixer: morph }} />
```

Animations between numbers (not strings with units, like `"100px"`),
and those where the mixer returns `undefined` for every pair, run as
they would without it. The rest run on the main thread, where the
mixer can be called. Animations that only run in the browser, like
those from `motion/mini`, don't use it. Values Motion can't animate,
like text without numbers, still change at once.

A mixer can be asked for the same pair more than once, so keep any
costly setup for when its function is first called.

#### Parameters [#parameters]

##### from [#from-1]

`any`

##### to [#to]

`any`

#### Returns [#returns]

`Mixer`\<`any`> | `undefined`

#### Inherited from [#inherited-from-19]

`AnimationOptions.mixer`

***

### modifyTarget? [#modifytarget]

\> `optional` **modifyTarget?**: (`v`) => `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2407

A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.

#### Parameters [#parameters-1]

##### v [#v]

`number`

#### Returns [#returns-1]

`number`

#### Inherited from [#inherited-from-20]

`AnimationOptions.modifyTarget`

***

### out? [#out]

\> `optional` **out?**: `boolean` | `Transition`\<`any`>

Defined in: node_modules/motion-dom/dist/index.d.ts:2556

The transition a value uses when it leaves this state for a
lower-priority one, like `whileHover` ending and values returning to
`animate`. `true` reuses this transition. Otherwise, the state being
entered defines the transition.

On `initial`, it's used for the mount animation.

```jsx
<motion.div
  initial={{ scale: 0, transition: { out: { delay: 1 } } }}
  animate={{ scale: 1 }}
  whileHover={{ scale: 2, transition: { out: true, duration: 0.2 } }}
/>
```

#### Inherited from [#inherited-from-21]

`AnimationOptions.out`

***

### path? [#path]

\> `optional` **path?**: `MotionPath` | `MotionPath` & `ValueTransition`

Defined in: node_modules/motion-dom/dist/index.d.ts:2575

The path the element travels between its old and new x/y positions.
Slot in a path factory (e.g. `arc()`) to swap the default
straight-line interpolation for something curved.

Can be used in keyframe animations (`transition.path`) and layout
animations (`transition.layout.path`), including with `useAnimate`.

#### Inherited from [#inherited-from-22]

`AnimationOptions.path`

***

### power? [#power]

\> `optional` **power?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2394

A higher power value equals a further target. Set to `0.8` by default.

#### Inherited from [#inherited-from-23]

`AnimationOptions.power`

***

### reduceMotion? [#reducemotion]

\> `optional` **reduceMotion?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2727

Whether to reduce motion for transform/layout animations.

* `true`: Skip transform/layout animations (instant transition)
* `false`: Always animate transforms/layout
* `undefined`: Use device preference (default behavior)

#### Inherited from [#inherited-from-24]

`AnimationOptions.reduceMotion`

***

### repeat? [#repeat]

\> `optional` **repeat?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2280

The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.

Without setting `repeatType`, this will loop the animation.

#### Inherited from [#inherited-from-25]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeat`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeat)

***

### repeatDelay? [#repeatdelay]

\> `optional` **repeatDelay?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2299

When repeating an animation, `repeatDelay` will set the
duration of the time to wait, in seconds, between each repetition.

#### Inherited from [#inherited-from-26]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatDelay`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeatdelay)

***

### repeatType? [#repeattype]

\> `optional` **repeatType?**: `RepeatType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2292

How to repeat the animation. This can be either:

"loop": Repeats the animation from the start

"reverse": Alternates between forward and backwards playback

"mirror": Switches `from` and `to` alternately

#### Inherited from [#inherited-from-27]

[`PixiVNJsonAnimateSequenceOptions`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions).[`repeatType`](/pixi-vn-json/index/interfaces/PixiVNJsonAnimateSequenceOptions#repeattype)

***

### restDelta? [#restdelta]

\> `optional` **restDelta?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2317

End animation if distance is below this value and speed is below
`restSpeed`. When animation ends, spring gets "snapped" to. Set to
`0.01` by default.

#### Inherited from [#inherited-from-28]

`AnimationOptions.restDelta`

***

### restSpeed? [#restspeed]

\> `optional` **restSpeed?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2309

End animation if absolute speed (in units per second) drops below this
value and delta is smaller than `restDelta`. Set to `0.01` by default.

#### Inherited from [#inherited-from-29]

`AnimationOptions.restSpeed`

***

### skipAnimations? [#skipanimations]

\> `optional` **skipAnimations?**: `boolean`

Defined in: node_modules/motion-dom/dist/index.d.ts:2564

If true, the animation skips straight to its final value instead of
tweening. Used by `MotionConfig`'s `skipAnimations` to opt entire
subtrees out of animation (e.g. for E2E screenshot stability).

#### Inherited from [#inherited-from-30]

`AnimationOptions.skipAnimations`

***

### ~~staggerChildren?~~ [#staggerchildren]

\> `optional` **staggerChildren?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2480

When using variants, animations of child components can be staggered by this
duration (in seconds).

For instance, if `staggerChildren` is `0.01`, the first child will be
delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so
on.

The calculated stagger delay will be added to `delayChildren`.

#### Deprecated [#deprecated]

* Use `delayChildren: stagger(interval)` instead.

#### Inherited from [#inherited-from-31]

`AnimationOptions.staggerChildren`

***

### ~~staggerDirection?~~ [#staggerdirection]

\> `optional` **staggerDirection?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2489

The direction in which to stagger children.

A value of `1` staggers from the first to the last while `-1`
staggers from the last to the first.

#### Deprecated [#deprecated-1]

* Use `delayChildren: stagger(interval, { from: "last" })` instead.

#### Inherited from [#inherited-from-32]

`AnimationOptions.staggerDirection`

***

### startTime? [#starttime]

\> `optional` **startTime?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2529

#### Inherited from [#inherited-from-33]

`AnimationOptions.startTime`

***

### stiffness? [#stiffness]

\> `optional` **stiffness?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2362

Stiffness of the spring. Higher values will create more sudden movement.
Set to `100` by default.

#### Default [#default-4]

```ts
100

@public
```

#### Inherited from [#inherited-from-34]

`AnimationOptions.stiffness`

***

### tickerAliasToResume? [#tickeraliastoresume]

\> `optional` **tickerAliasToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/tickers.d.ts:474

If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.

#### Default [#default-5]

```ts
[]
```

#### Inherited from [#inherited-from-35]

`AnimationOptions.tickerAliasToResume`

***

### tickerIdToResume? [#tickeridtoresume]

\> `optional` **tickerIdToResume?**: `string` | `string`\[]

Defined in: node_modules/@drincs/pixi-vn/dist/tickers.d.ts:479

A string containing the ticker ID to resume after the animation completes.

#### Default [#default-6]

```ts
[]
```

#### Inherited from [#inherited-from-36]

`AnimationOptions.tickerIdToResume`

***

### timeConstant? [#timeconstant]

\> `optional` **timeConstant?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2401

Adjusting the time constant will change the duration of the
deceleration, thereby affecting its feel. Set to `700` by default.

#### Inherited from [#inherited-from-37]

`AnimationOptions.timeConstant`

***

### times? [#times]

\> `optional` **times?**: `number`\[]

Defined in: node_modules/motion-dom/dist/index.d.ts:2499

#### Inherited from [#inherited-from-38]

`AnimationOptions.times`

***

### type? [#type]

\> `optional` **type?**: `AnimationGeneratorType`

Defined in: node_modules/motion-dom/dist/index.d.ts:2521

Type of animation to use.

* "tween": Duration-based animation with ease curve
* "spring": Physics or duration-based spring animation
* false: Use an instant animation

#### Inherited from [#inherited-from-39]

`AnimationOptions.type`

***

### velocity? [#velocity]

\> `optional` **velocity?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2302

#### Inherited from [#inherited-from-40]

`AnimationOptions.velocity`

***

### visualDuration? [#visualduration]

\> `optional` **visualDuration?**: `number`

Defined in: node_modules/motion-dom/dist/index.d.ts:2337

If visualDuration is set, this will override duration.

The visual duration is a time, set in seconds, that the animation will take to visually appear to reach its target.

In other words, the bulk of the transition will occur before this time, and the "bouncy bit" will mostly happen after.

This makes it easier to edit a spring, as well as visually coordinate it with other time-based animations.

#### Inherited from [#inherited-from-41]

`AnimationOptions.visualDuration`

***

### when? [#when]

\> `optional` **when?**: `string` | `false`

Defined in: node_modules/motion-dom/dist/index.d.ts:2458

Describes the relationship between the transition and its children. Set
to `false` by default.

#### Remarks [#remarks]

When using variants, the transition can be scheduled in relation to its
children with either `"beforeChildren"` to finish this transition before
starting children transitions, `"afterChildren"` to finish children
transitions before starting this transition.

#### Inherited from [#inherited-from-42]

`AnimationOptions.when`
