Pixi’VNInterface: PixiVNJsonAnimateSequenceOptions
Defined in: src/schema/PixiVNJsonCanvasAnimate.ts:40
Additional options controlling the sequence playback.
Extends
Properties
aliasToRemoveAfter?
> optional aliasToRemoveAfter?: string | string[]
Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:209
An array of strings containing the aliases of the canvas components to remove after the animation completes.
Default
[]Inherited from
SequenceOptions.aliasToRemoveAfter
completeOnContinue?
> optional completeOnContinue?: boolean
Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:234
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
falseInherited from
SequenceOptions.completeOnContinue
defaultTransition?
> optional defaultTransition?: Transition
Defined in: node_modules/framer-motion/dist/dom.d.ts:63
Inherited from
SequenceOptions.defaultTransition
delay?
> optional delay?: number
Defined in: node_modules/framer-motion/dist/dom.d.ts:61
Inherited from
SequenceOptions.delay
duration?
> optional duration?: number
Defined in: node_modules/framer-motion/dist/dom.d.ts:62
Inherited from
SequenceOptions.duration
forceCompleteBeforeNext?
> optional forceCompleteBeforeNext?: boolean
Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:228
Deprecated
Use completeOnContinue instead.
Inherited from
SequenceOptions.forceCompleteBeforeNext
onComplete?
> optional onComplete?: () => void
Defined in: node_modules/framer-motion/dist/dom.d.ts:66
Returns
void
Inherited from
SequenceOptions.onComplete
reduceMotion?
> optional reduceMotion?: boolean
Defined in: node_modules/framer-motion/dist/dom.d.ts:64
Inherited from
SequenceOptions.reduceMotion
repeat?
> optional repeat?: number
Defined in: node_modules/motion-dom/dist/index.d.ts:1966
The number of times to repeat the transition. Set to Infinity for perpetual repeating.
Without setting repeatType, this will loop the animation.
Inherited from
SequenceOptions.repeat
repeatDelay?
> optional repeatDelay?: number
Defined in: node_modules/motion-dom/dist/index.d.ts:1985
When repeating an animation, repeatDelay will set the
duration of the time to wait, in seconds, between each repetition.
Inherited from
SequenceOptions.repeatDelay
repeatType?
> optional repeatType?: RepeatType
Defined in: node_modules/motion-dom/dist/index.d.ts:1978
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
SequenceOptions.repeatType
skipAnimations?
> optional skipAnimations?: boolean
Defined in: node_modules/framer-motion/dist/dom.d.ts:65
Inherited from
SequenceOptions.skipAnimations
tickerAliasToResume?
> optional tickerAliasToResume?: string | string[]
Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:219
If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.
Default
[]Inherited from
SequenceOptions.tickerAliasToResume
tickerIdToResume?
> optional tickerIdToResume?: string | string[]
Defined in: node_modules/@drincs/pixi-vn/dist/canvas.d.ts:224
A string containing the ticker ID to resume after the animation completes.
Default
[]Inherited from
SequenceOptions.tickerIdToResume