@drincs/pixi-vn 1.9.2 → 1.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/{ContainerMemory-BpDgacyr.d.cts → ContainerMemory-DNqSVzLY.d.cts} +12 -116
- package/dist/{ContainerMemory-BpDgacyr.d.ts → ContainerMemory-DNqSVzLY.d.ts} +12 -116
- package/dist/canvas.cjs +2 -2
- package/dist/canvas.d.cts +1279 -551
- package/dist/canvas.d.ts +1279 -551
- package/dist/canvas.mjs +2 -2
- package/dist/characters.cjs +1 -1
- package/dist/characters.mjs +1 -1
- package/dist/{chunk-6GLWL3NH.mjs → chunk-5MVDNAT4.mjs} +1 -1
- package/dist/chunk-6OABTG5R.mjs +1 -0
- package/dist/chunk-AW5XWF24.mjs +1 -0
- package/dist/chunk-LXIKP2K5.mjs +1 -0
- package/dist/chunk-S7HZUIEI.mjs +1 -0
- package/dist/core.cjs +1 -1
- package/dist/core.d.cts +61 -5
- package/dist/core.d.ts +61 -5
- package/dist/core.mjs +1 -1
- package/dist/filters.cjs +1 -0
- package/dist/filters.d.cts +182 -0
- package/dist/filters.d.ts +182 -0
- package/dist/filters.mjs +1 -0
- package/dist/history.cjs +1 -1
- package/dist/history.d.cts +2 -2
- package/dist/history.d.ts +2 -2
- package/dist/history.mjs +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +43 -3
- package/dist/index.d.ts +43 -3
- package/dist/index.mjs +2 -2
- package/dist/motion.cjs +1 -1
- package/dist/motion.d.cts +30 -8
- package/dist/motion.d.ts +30 -8
- package/dist/motion.mjs +1 -1
- package/dist/narration.cjs +1 -1
- package/dist/narration.d.cts +2 -1
- package/dist/narration.d.ts +2 -1
- package/dist/narration.mjs +1 -1
- package/dist/pixi/browser.js +170 -169
- package/dist/sound.mjs +1 -1
- package/dist/storage.cjs +1 -1
- package/dist/storage.d.cts +1 -1
- package/dist/storage.d.ts +1 -1
- package/dist/storage.mjs +1 -1
- package/dist/tickers.cjs +1 -0
- package/dist/tickers.d.cts +555 -0
- package/dist/tickers.d.ts +555 -0
- package/dist/tickers.mjs +1 -0
- package/dist/vite.cjs +6 -4
- package/dist/vite.d.cts +64 -0
- package/dist/vite.d.ts +64 -0
- package/dist/vite.mjs +6 -4
- package/dist/worker.cjs +1 -0
- package/dist/worker.d.cts +153 -0
- package/dist/worker.d.ts +153 -0
- package/dist/worker.mjs +1 -0
- package/package.json +28 -1
- package/dist/chunk-HQQ5WH6C.mjs +0 -1
- package/dist/chunk-I7DOUH5V.mjs +0 -1
package/dist/canvas.d.ts
CHANGED
|
@@ -1,235 +1,19 @@
|
|
|
1
1
|
import * as _drincs_pixi_vn_pixi_js from '@drincs/pixi-vn/pixi.js';
|
|
2
|
-
import _drincs_pixi_vn_pixi_js__default, { Container as Container$1, ContainerChild,
|
|
2
|
+
import _drincs_pixi_vn_pixi_js__default, { Container as Container$1, ContainerChild, Application, Rectangle as Rectangle$1, ApplicationOptions, UPDATE_PRIORITY as UPDATE_PRIORITY$1, PointData, ContainerOptions as ContainerOptions$1, SpriteOptions as SpriteOptions$1, CanvasTextOptions, Texture as Texture$1, TextureSourceLike, ContainerEvents, EventEmitter, ObservablePoint, TextureSource, TextOptions as TextOptions$1 } from '@drincs/pixi-vn/pixi.js';
|
|
3
3
|
export { TextureSourceLike, Ticker as TickerValue } from '@drincs/pixi-vn/pixi.js';
|
|
4
4
|
import { KeyframesType, AnimationOptions, ObjectSegment, ObjectSegmentWithTransition, SequenceOptions } from '@drincs/pixi-vn/motion';
|
|
5
|
+
import { TickerInfo, TickersSequence, TickerArgs, Ticker, TickersInterface } from '@drincs/pixi-vn/tickers';
|
|
6
|
+
export * from '@drincs/pixi-vn/tickers';
|
|
7
|
+
export { TickersInterface as CanvasTickersInterface } from '@drincs/pixi-vn/tickers';
|
|
5
8
|
import { Devtools } from '@pixi/devtools';
|
|
6
|
-
import {
|
|
7
|
-
export {
|
|
9
|
+
import { C as CanvasBaseItemMemory, a as CanvasBaseItem, b as CanvasGameState, c as ContainerChild$1, A as AdditionalPositionsExtensionProps, L as ListenerExtensionMemory, d as ListenerExtension, e as AdditionalPositionsExtension, O as OnEventsHandlers, f as ContainerMemory } from './ContainerMemory-DNqSVzLY.js';
|
|
10
|
+
export { g as addListenerHandler, h as analizePositionsExtensionProps } from './ContainerMemory-DNqSVzLY.js';
|
|
8
11
|
export { AnimationOptions as MotionAnimationOptions } from 'motion';
|
|
9
12
|
import { OnErrorHandler } from '@drincs/pixi-vn/core';
|
|
13
|
+
import '@drincs/pixi-vn/filters';
|
|
10
14
|
|
|
11
15
|
type Layer = Container$1<ContainerChild>;
|
|
12
16
|
|
|
13
|
-
type TickerValue = Ticker;
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* A class is used to create a ticker element to add into a Pixi Application.
|
|
17
|
-
* You can use {@link canvas.tickers.add()} to add this element into the application.
|
|
18
|
-
* This class should be extended and the fn method should be overridden.
|
|
19
|
-
* You must use the {@link tickerDecorator} to register the ticker in the game.
|
|
20
|
-
* In Ren'Py is a transform.
|
|
21
|
-
* @template TArgs The type of the arguments that you want to pass to the ticker.
|
|
22
|
-
* @example
|
|
23
|
-
* ```ts
|
|
24
|
-
* \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
|
|
25
|
-
* export class RotateTicker extends TickerBase<{ speed?: number }> {
|
|
26
|
-
* override fn(
|
|
27
|
-
* t: TickerValue, // the ticker that is calling this method
|
|
28
|
-
* args: { // the arguments that you passed when you added the ticker
|
|
29
|
-
* speed?: number,
|
|
30
|
-
* },
|
|
31
|
-
* aliases: string[], // the aliases of the canvas elements that are connected to this ticker
|
|
32
|
-
* tickerId: string, // the id of the ticker. You can use this to get the ticker from the canvas.tickers.currentTickers
|
|
33
|
-
* ): void {
|
|
34
|
-
* let speed = args.speed === undefined ? 0.1 : args.speed
|
|
35
|
-
* aliases.forEach((alias) => {
|
|
36
|
-
* let element = canvas.find(alias)
|
|
37
|
-
* if (element && element instanceof Container) {
|
|
38
|
-
* if (clockwise)
|
|
39
|
-
* element.rotation += speed * t.deltaTime
|
|
40
|
-
* else
|
|
41
|
-
* element.rotation -= speed * t.deltaTime
|
|
42
|
-
* }
|
|
43
|
-
* })
|
|
44
|
-
* }
|
|
45
|
-
* }
|
|
46
|
-
* ```
|
|
47
|
-
*/
|
|
48
|
-
declare abstract class TickerBase<TArgs extends TickerArgs> implements Ticker$1<TArgs> {
|
|
49
|
-
/**
|
|
50
|
-
* @param args The arguments that you want to pass to the ticker.
|
|
51
|
-
* @param options The options of the ticker.
|
|
52
|
-
*/
|
|
53
|
-
constructor(args: TArgs, options?: {
|
|
54
|
-
/**
|
|
55
|
-
* The duration of the ticker in seconds. If is undefined, the step will end only when the animation is finished (if the animation doesn't have a goal to reach then it won't finish). @default undefined
|
|
56
|
-
*/
|
|
57
|
-
duration?: number;
|
|
58
|
-
/**
|
|
59
|
-
* The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
|
|
60
|
-
*/
|
|
61
|
-
priority?: UPDATE_PRIORITY$1;
|
|
62
|
-
/**
|
|
63
|
-
* The id of the ticker. This param is used by the system when will ber restoring the tickers from a save. If not provided, a random id will be generated. @default undefined
|
|
64
|
-
*/
|
|
65
|
-
id?: string;
|
|
66
|
-
/**
|
|
67
|
-
* The aliases of the canvas elements that are connected to this ticker. This is used by the system to know which canvas elements are connected to this ticker, and to pass them to the fn method. @default []
|
|
68
|
-
*/
|
|
69
|
-
canvasElementAliases?: string[];
|
|
70
|
-
});
|
|
71
|
-
readonly alias: string;
|
|
72
|
-
readonly id: string;
|
|
73
|
-
args: TArgs;
|
|
74
|
-
duration?: number;
|
|
75
|
-
priority?: UPDATE_PRIORITY$1;
|
|
76
|
-
protected ticker: _drincs_pixi_vn_pixi_js.Ticker;
|
|
77
|
-
canvasElementAliases: string[];
|
|
78
|
-
private generateTickerId;
|
|
79
|
-
/**
|
|
80
|
-
* The method that will be called every frame.
|
|
81
|
-
* This method should be overridden and you can use {@link canvas.add()} to get the canvas element of the canvas, and edit them.
|
|
82
|
-
* @param _ticker The ticker that is calling this method
|
|
83
|
-
* @param _args The arguments that you passed when you added the ticker
|
|
84
|
-
* @param _alias The alias of the canvas elements that are connected to this ticker
|
|
85
|
-
* @param _tickerId The id of the ticker. You can use this to get the ticker from the {@link canvas.tickers.currentTickers}
|
|
86
|
-
*/
|
|
87
|
-
abstract fn(_ticker: TickerValue, _args: TArgs, _alias: string | string[], _tickerId: string): void;
|
|
88
|
-
protected fnValue?: () => void;
|
|
89
|
-
complete(_options?: {
|
|
90
|
-
ignoreTickerSteps?: boolean;
|
|
91
|
-
}): void;
|
|
92
|
-
stop(): void;
|
|
93
|
-
start(): void;
|
|
94
|
-
pause(): void;
|
|
95
|
-
play(): void;
|
|
96
|
-
get paused(): boolean;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* Is a decorator that register a ticker in the game.
|
|
101
|
-
* Is a required decorator for use the ticker in the game.
|
|
102
|
-
* Thanks to this decoration the game has the possibility of updating the tickers to the latest modification and saving the game.
|
|
103
|
-
* @param name is th identifier of the label, by default is the name of the class
|
|
104
|
-
* @returns
|
|
105
|
-
*/
|
|
106
|
-
declare function tickerDecorator(name?: string): (target: {
|
|
107
|
-
new (args: any, options?: {
|
|
108
|
-
duration?: number;
|
|
109
|
-
priority?: UPDATE_PRIORITY$1;
|
|
110
|
-
id?: string;
|
|
111
|
-
canvasElementAliases?: string[];
|
|
112
|
-
}): Ticker$1<any>;
|
|
113
|
-
}) => void;
|
|
114
|
-
declare namespace RegisteredTickers {
|
|
115
|
-
/**
|
|
116
|
-
* Register a ticker in the game.
|
|
117
|
-
* @param target The class of the ticker.
|
|
118
|
-
* @param name Name of the ticker, by default it will use the class name. If the name is already registered, it will show a warning
|
|
119
|
-
*/
|
|
120
|
-
function add(target: {
|
|
121
|
-
new (args: any, options?: {
|
|
122
|
-
duration?: number;
|
|
123
|
-
priority?: UPDATE_PRIORITY$1;
|
|
124
|
-
id?: string;
|
|
125
|
-
canvasElementAliases?: string[];
|
|
126
|
-
}): Ticker$1<any>;
|
|
127
|
-
}, name?: string): void;
|
|
128
|
-
/**
|
|
129
|
-
* Get a ticker by the id.
|
|
130
|
-
* @param canvasId The id of the ticker.
|
|
131
|
-
* @returns The ticker type.
|
|
132
|
-
*/
|
|
133
|
-
function get<T = Ticker$1<any>>(tickerId: string): T | undefined;
|
|
134
|
-
/**
|
|
135
|
-
* Get a ticker instance by the id.
|
|
136
|
-
* @param tickerId The id of the ticker.
|
|
137
|
-
* @param args The arguments that you want to pass to the ticker.
|
|
138
|
-
* @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
|
|
139
|
-
* @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
|
|
140
|
-
* @returns The instance of the ticker
|
|
141
|
-
*/
|
|
142
|
-
function getInstance<TArgs extends TickerArgs>(tickerId: string, args: TArgs, options?: {
|
|
143
|
-
duration?: number;
|
|
144
|
-
priority?: UPDATE_PRIORITY$1;
|
|
145
|
-
id?: string;
|
|
146
|
-
canvasElementAliases?: string[];
|
|
147
|
-
}): Ticker$1<TArgs> | undefined;
|
|
148
|
-
/**
|
|
149
|
-
* Get a list of all tickers registered.
|
|
150
|
-
* @returns An array of tickers.
|
|
151
|
-
*/
|
|
152
|
-
function values(): {
|
|
153
|
-
new (args: any, options?: {
|
|
154
|
-
duration?: number;
|
|
155
|
-
priority?: UPDATE_PRIORITY$1;
|
|
156
|
-
id?: string;
|
|
157
|
-
canvasElementAliases?: string[];
|
|
158
|
-
}): Ticker$1<any>;
|
|
159
|
-
}[];
|
|
160
|
-
/**
|
|
161
|
-
* Check if a ticker is registered.
|
|
162
|
-
* @param id The id of the ticker.
|
|
163
|
-
* @returns True if the ticker is registered, false otherwise.
|
|
164
|
-
*/
|
|
165
|
-
function has(id: string): boolean;
|
|
166
|
-
/**
|
|
167
|
-
* Get a list of all ticker ids registered.
|
|
168
|
-
* @returns An array of label ids.
|
|
169
|
-
*/
|
|
170
|
-
function keys(): string[];
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
type TickerProgrationType = TickerProgrationLinear | TickerProgrationExponential;
|
|
174
|
-
|
|
175
|
-
interface TickerProgrationLinear {
|
|
176
|
-
/**
|
|
177
|
-
* The amount of the speed to increase every frame.
|
|
178
|
-
*/
|
|
179
|
-
amt: number;
|
|
180
|
-
/**
|
|
181
|
-
* The limit of the effect
|
|
182
|
-
*/
|
|
183
|
-
limit?: number;
|
|
184
|
-
type: "linear";
|
|
185
|
-
}
|
|
186
|
-
interface TickerProgrationExponential {
|
|
187
|
-
/**
|
|
188
|
-
* The percentage of the speed to increase every frame. if the percentage is 0.1, the speed will increase by 10% every frame.
|
|
189
|
-
*/
|
|
190
|
-
percentage: number;
|
|
191
|
-
/**
|
|
192
|
-
* The limit of the effect
|
|
193
|
-
*/
|
|
194
|
-
limit?: number;
|
|
195
|
-
type: "exponential";
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
interface TickerTimeoutHistory {
|
|
199
|
-
aliases: string[];
|
|
200
|
-
ticker: string;
|
|
201
|
-
canBeDeletedBeforeEnd: boolean;
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
type CommonTickerProps = {
|
|
205
|
-
/**
|
|
206
|
-
* An array of strings containing the aliases of the canvas components to remove after the animation completes.
|
|
207
|
-
* @default []
|
|
208
|
-
*/
|
|
209
|
-
aliasToRemoveAfter?: string[] | string;
|
|
210
|
-
/**
|
|
211
|
-
* If true, the effect only starts if the canvas element have a texture
|
|
212
|
-
* @default false
|
|
213
|
-
*/
|
|
214
|
-
startOnlyIfHaveTexture?: boolean;
|
|
215
|
-
/**
|
|
216
|
-
* If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.
|
|
217
|
-
* @default []
|
|
218
|
-
*/
|
|
219
|
-
tickerAliasToResume?: string[] | string;
|
|
220
|
-
/**
|
|
221
|
-
* A string containing the ticker ID to resume after the animation completes.
|
|
222
|
-
* @default []
|
|
223
|
-
*/
|
|
224
|
-
tickerIdToResume?: string[] | string;
|
|
225
|
-
/**
|
|
226
|
-
* 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.
|
|
227
|
-
* When true, calling {@link narration.continue()} forces the current content to complete before advancing to the next narrative step.
|
|
228
|
-
* @default false
|
|
229
|
-
*/
|
|
230
|
-
completeOnContinue?: boolean;
|
|
231
|
-
};
|
|
232
|
-
|
|
233
17
|
interface CanvasBaseInterface<T2 extends CanvasBaseItemMemory> extends CanvasBaseItem<T2>, Container$1 {
|
|
234
18
|
}
|
|
235
19
|
|
|
@@ -306,155 +90,6 @@ interface CanvasLayersInterface {
|
|
|
306
90
|
remove(label: string): void;
|
|
307
91
|
}
|
|
308
92
|
|
|
309
|
-
interface CanvasTickersInterface {
|
|
310
|
-
/**
|
|
311
|
-
* Transfer the tickers from an old alias to a new alias.
|
|
312
|
-
* @param oldAlias Old alias
|
|
313
|
-
* @param newAlias New alias
|
|
314
|
-
* @param mode If "move", the old alias will be removed from the ticker. If "duplicate", the old alias will be kept in the ticker.
|
|
315
|
-
*/
|
|
316
|
-
transfer(oldAlias: string, newAlias: string, mode?: "move" | "duplicate"): void;
|
|
317
|
-
/**
|
|
318
|
-
* Currently tickers that are running.
|
|
319
|
-
*/
|
|
320
|
-
readonly currentTickers: Map<string, TickerInfo<any>>;
|
|
321
|
-
/**
|
|
322
|
-
* The steps of the tickers
|
|
323
|
-
*/
|
|
324
|
-
readonly currentTickersSteps: Map<string, Map<string, TickersSequence>>;
|
|
325
|
-
/**
|
|
326
|
-
* Find a ticker by its id.
|
|
327
|
-
* @param tickerId The id of the ticker to be found.
|
|
328
|
-
* @param args The args of the ticker.
|
|
329
|
-
* @returns The ticker if found, undefined otherwise.
|
|
330
|
-
*/
|
|
331
|
-
find<TArgs extends TickerArgs>(tickerId: string, args?: TArgs): Ticker$1<TArgs> | undefined;
|
|
332
|
-
/**
|
|
333
|
-
* Run a ticker. You can run multiple add with the same alias and different tickerClasses.
|
|
334
|
-
* If you run a ticker with the same alias and tickerClass, the old ticker will be removed.
|
|
335
|
-
* If already exists a sequence of tickers with the same alias, it will be removed.
|
|
336
|
-
* @param canvasElementAlias The alias of the canvas element that will use the ticker.
|
|
337
|
-
* @param ticker The ticker class to be run.
|
|
338
|
-
* @returns The id of the ticker that was added.
|
|
339
|
-
* @example
|
|
340
|
-
* ```ts
|
|
341
|
-
* canvas.tickers.add("alien", new RotateTicker({ speed: 0.2 }))
|
|
342
|
-
* ```
|
|
343
|
-
*/
|
|
344
|
-
add<TArgs extends TickerArgs>(canvasElementAlias: string | string[], ticker: Ticker$1<TArgs>): string | undefined;
|
|
345
|
-
/**
|
|
346
|
-
* Run a sequence of tickers.
|
|
347
|
-
* @param alias The alias of canvas element that will use the tickers.
|
|
348
|
-
* @param steps The steps of the tickers.
|
|
349
|
-
* @param currentStepNumber The current step number. It is used to continue the sequence of tickers.
|
|
350
|
-
* @returns The id of tickers.
|
|
351
|
-
* @example
|
|
352
|
-
* ```ts
|
|
353
|
-
* canvas.tickers.addSequence("alien", [
|
|
354
|
-
* new RotateTicker({ speed: 0.1, clockwise: true }, 2), // runs for 2 seconds
|
|
355
|
-
* new RotateTicker({ speed: 0.2, clockwise: false }, 2),
|
|
356
|
-
* ])
|
|
357
|
-
* ```
|
|
358
|
-
* @deprecated
|
|
359
|
-
*/
|
|
360
|
-
addSequence(alias: string, steps: Ticker$1<any>[], currentStepNumber?: number): string | undefined;
|
|
361
|
-
/**
|
|
362
|
-
* Remove a connection between a canvas element and a ticker.
|
|
363
|
-
* And remove the ticker if there is no canvas element connected to it.
|
|
364
|
-
* @param alias The alias of the canvas element that will use the ticker.
|
|
365
|
-
* @param ticker The ticker class to be removed.
|
|
366
|
-
* @example
|
|
367
|
-
* ```ts
|
|
368
|
-
* canvas.tickers.unlinkComponent("alien", RotateTicker)
|
|
369
|
-
* ```
|
|
370
|
-
*/
|
|
371
|
-
unlinkComponent(alias: string | string[], ticker?: {
|
|
372
|
-
new (): Ticker$1<any>;
|
|
373
|
-
} | string): void;
|
|
374
|
-
/**
|
|
375
|
-
* Remove all tickers from the canvas.
|
|
376
|
-
*/
|
|
377
|
-
removeAll(): void;
|
|
378
|
-
/**
|
|
379
|
-
* Remove a ticker by the id.
|
|
380
|
-
* @param tickerId The id or an array of ids of the ticker to be removed.
|
|
381
|
-
*/
|
|
382
|
-
remove(tickerId: string | string[]): void;
|
|
383
|
-
/**
|
|
384
|
-
* Pause a ticker. If a paused ticker have a time to be removed, it will be removed after the time.
|
|
385
|
-
* @param filters The filters to pause the ticker.
|
|
386
|
-
* @returns The ids of the paused tickers.
|
|
387
|
-
*/
|
|
388
|
-
pause(filters: {
|
|
389
|
-
/**
|
|
390
|
-
* The alias of the canvas element that will use the ticker.
|
|
391
|
-
* Will pause all tickers that are connected to this canvas element.
|
|
392
|
-
*/
|
|
393
|
-
canvasAlias: string;
|
|
394
|
-
/**
|
|
395
|
-
* Ticker ids excluded from the pause. If not provided, all tickers will be paused.
|
|
396
|
-
*/
|
|
397
|
-
tickerIdsExcluded?: string[];
|
|
398
|
-
} | {
|
|
399
|
-
/**
|
|
400
|
-
* The id of the ticker to be paused. If provided, only this ticker will be paused.
|
|
401
|
-
*/
|
|
402
|
-
id: string | string[];
|
|
403
|
-
}): string[];
|
|
404
|
-
/**
|
|
405
|
-
* Resume a ticker.
|
|
406
|
-
* @param filters The filters to resume the ticker.
|
|
407
|
-
*/
|
|
408
|
-
resume(filters: {
|
|
409
|
-
/**
|
|
410
|
-
* The alias of the canvas element that will use the ticker.
|
|
411
|
-
* Will resume all tickers that are connected to this canvas element.
|
|
412
|
-
*/
|
|
413
|
-
canvasAlias: string;
|
|
414
|
-
} | {
|
|
415
|
-
/**
|
|
416
|
-
* The id of the ticker to be resumed. If provided, only this ticker will be resumed.
|
|
417
|
-
*/
|
|
418
|
-
id: string | string[];
|
|
419
|
-
}): void;
|
|
420
|
-
/**
|
|
421
|
-
* Check if a ticker is paused.
|
|
422
|
-
* @param alias The alias of the canvas element that will use the ticker.
|
|
423
|
-
* @param tickerId The ticker that will be checked.
|
|
424
|
-
* @returns If the ticker is paused.
|
|
425
|
-
*/
|
|
426
|
-
isPaused(alias: string, tickerId?: string): boolean;
|
|
427
|
-
/**
|
|
428
|
-
* Add a ticker that must be completed before the next step.
|
|
429
|
-
* This method is used for example into a transition between scenes.
|
|
430
|
-
* @param step The step that the ticker must be completed before the next step.
|
|
431
|
-
*/
|
|
432
|
-
completeOnStepEnd(step: {
|
|
433
|
-
/**
|
|
434
|
-
* The id of the step.
|
|
435
|
-
*/
|
|
436
|
-
id: string;
|
|
437
|
-
/**
|
|
438
|
-
* If is a sequence of tickers, the alias of the sequence of tickers.
|
|
439
|
-
*/
|
|
440
|
-
alias?: string;
|
|
441
|
-
}): void;
|
|
442
|
-
/**
|
|
443
|
-
* This method force the completion of the tickers that are running.
|
|
444
|
-
* This funcions is called in the next step.
|
|
445
|
-
* @param id The id of the ticker. If the alias provided, the id is the id of the sequence of tickers.
|
|
446
|
-
* @param alias The alias of the sequence of tickers.
|
|
447
|
-
*/
|
|
448
|
-
forceCompletion(id: string, alias?: string): Promise<void>;
|
|
449
|
-
onComplete(tickerId: string, options: {
|
|
450
|
-
aliasToRemoveAfter: string[];
|
|
451
|
-
tickerAliasToResume: string[];
|
|
452
|
-
tickerIdToResume: string[];
|
|
453
|
-
ignoreTickerSteps?: boolean;
|
|
454
|
-
stopTicker?: boolean;
|
|
455
|
-
}): void;
|
|
456
|
-
}
|
|
457
|
-
|
|
458
93
|
interface CanvasManagerInterface {
|
|
459
94
|
/**
|
|
460
95
|
* The PIXI Application instance.
|
|
@@ -539,7 +174,7 @@ interface CanvasManagerInterface {
|
|
|
539
174
|
* @param oldAlias Old alias
|
|
540
175
|
* @param newAlias New alias
|
|
541
176
|
* @param mode If "move", the old alias will be removed from the ticker. If "duplicate", the old alias will be kept in the ticker.
|
|
542
|
-
* @deprecated Use
|
|
177
|
+
* @deprecated Use `tickers.transfer` from `@drincs/pixi-vn` instead.
|
|
543
178
|
*/
|
|
544
179
|
transferTickers(oldAlias: string, newAlias: string, mode?: "move" | "duplicate"): void;
|
|
545
180
|
/**
|
|
@@ -622,12 +257,12 @@ interface CanvasManagerInterface {
|
|
|
622
257
|
/** Edit Tickers Methods */
|
|
623
258
|
/**
|
|
624
259
|
* Currently tickers that are running.
|
|
625
|
-
* @deprecated Use
|
|
260
|
+
* @deprecated Use `tickers.currentTickers` from `@drincs/pixi-vn` instead.
|
|
626
261
|
*/
|
|
627
262
|
readonly currentTickers: Map<string, TickerInfo<any>>;
|
|
628
263
|
/**
|
|
629
264
|
* The steps of the tickers
|
|
630
|
-
* @deprecated Use
|
|
265
|
+
* @deprecated Use `tickers.currentTickersSteps` from `@drincs/pixi-vn` instead.
|
|
631
266
|
*/
|
|
632
267
|
readonly currentTickersSteps: Map<string, Map<string, TickersSequence>>;
|
|
633
268
|
/**
|
|
@@ -635,9 +270,9 @@ interface CanvasManagerInterface {
|
|
|
635
270
|
* @param tickerId The id of the ticker to be found.
|
|
636
271
|
* @param args The args of the ticker.
|
|
637
272
|
* @returns The ticker if found, undefined otherwise.
|
|
638
|
-
* @deprecated Use
|
|
273
|
+
* @deprecated Use `tickers.find` from `@drincs/pixi-vn` instead.
|
|
639
274
|
*/
|
|
640
|
-
findTicker<TArgs extends TickerArgs>(tickerId: string, args?: TArgs): Ticker
|
|
275
|
+
findTicker<TArgs extends TickerArgs>(tickerId: string, args?: TArgs): Ticker<TArgs> | undefined;
|
|
641
276
|
/**
|
|
642
277
|
* Run a ticker. You can run multiple addTicker with the same alias and different tickerClasses.
|
|
643
278
|
* If you run a ticker with the same alias and tickerClass, the old ticker will be removed.
|
|
@@ -649,9 +284,9 @@ interface CanvasManagerInterface {
|
|
|
649
284
|
* ```ts
|
|
650
285
|
* canvas.addTicker("alien", new RotateTicker({ speed: 0.2 }))
|
|
651
286
|
* ```
|
|
652
|
-
* @deprecated Use
|
|
287
|
+
* @deprecated Use `tickers.add` from `@drincs/pixi-vn` instead.
|
|
653
288
|
*/
|
|
654
|
-
addTicker<TArgs extends TickerArgs>(canvasElementAlias: string | string[], ticker: Ticker
|
|
289
|
+
addTicker<TArgs extends TickerArgs>(canvasElementAlias: string | string[], ticker: Ticker<TArgs>): string | undefined;
|
|
655
290
|
/**
|
|
656
291
|
* Run a sequence of tickers.
|
|
657
292
|
* @param alias The alias of canvas element that will use the tickers.
|
|
@@ -665,9 +300,9 @@ interface CanvasManagerInterface {
|
|
|
665
300
|
* new RotateTicker({ speed: 0.2, clockwise: false }, 2),
|
|
666
301
|
* ])
|
|
667
302
|
* ```
|
|
668
|
-
* @deprecated Use
|
|
303
|
+
* @deprecated Use `tickers.addSequence` from `@drincs/pixi-vn` instead.
|
|
669
304
|
*/
|
|
670
|
-
addTickersSequence(alias: string, steps: Ticker
|
|
305
|
+
addTickersSequence(alias: string, steps: Ticker<any>[], currentStepNumber?: number): string | undefined;
|
|
671
306
|
/**
|
|
672
307
|
* Remove a connection between a canvas element and a ticker.
|
|
673
308
|
* And remove the ticker if there is no canvas element connected to it.
|
|
@@ -677,27 +312,27 @@ interface CanvasManagerInterface {
|
|
|
677
312
|
* ```ts
|
|
678
313
|
* canvas.unlinkComponentFromTicker("alien", RotateTicker)
|
|
679
314
|
* ```
|
|
680
|
-
* @deprecated Use
|
|
315
|
+
* @deprecated Use `tickers.unlinkComponent` from `@drincs/pixi-vn` instead.
|
|
681
316
|
*/
|
|
682
317
|
unlinkComponentFromTicker(alias: string | string[], ticker?: {
|
|
683
|
-
new (): Ticker
|
|
318
|
+
new (): Ticker<any>;
|
|
684
319
|
} | string): void;
|
|
685
320
|
/**
|
|
686
321
|
* Remove all tickers from the canvas.
|
|
687
|
-
* @deprecated Use
|
|
322
|
+
* @deprecated Use `tickers.removeAll` from `@drincs/pixi-vn` instead.
|
|
688
323
|
*/
|
|
689
324
|
removeAllTickers(): void;
|
|
690
325
|
/**
|
|
691
326
|
* Remove a ticker by the id.
|
|
692
327
|
* @param tickerId The id or an array of ids of the ticker to be removed.
|
|
693
|
-
* @deprecated Use
|
|
328
|
+
* @deprecated Use `tickers.remove` from `@drincs/pixi-vn` instead.
|
|
694
329
|
*/
|
|
695
330
|
removeTicker(tickerId: string | string[]): void;
|
|
696
331
|
/**
|
|
697
332
|
* Pause a ticker. If a paused ticker have a time to be removed, it will be removed after the time.
|
|
698
333
|
* @param filters The filters to pause the ticker.
|
|
699
334
|
* @returns The ids of the paused tickers.
|
|
700
|
-
* @deprecated Use
|
|
335
|
+
* @deprecated Use `tickers.pause` from `@drincs/pixi-vn` instead.
|
|
701
336
|
*/
|
|
702
337
|
pauseTicker(filters: {
|
|
703
338
|
/**
|
|
@@ -718,7 +353,7 @@ interface CanvasManagerInterface {
|
|
|
718
353
|
/**
|
|
719
354
|
* Resume a ticker.
|
|
720
355
|
* @param filters The filters to resume the ticker.
|
|
721
|
-
* @deprecated Use
|
|
356
|
+
* @deprecated Use `tickers.resume` from `@drincs/pixi-vn` instead.
|
|
722
357
|
*/
|
|
723
358
|
resumeTicker(filters: {
|
|
724
359
|
/**
|
|
@@ -733,7 +368,7 @@ interface CanvasManagerInterface {
|
|
|
733
368
|
id: string | string[];
|
|
734
369
|
}): void;
|
|
735
370
|
/**
|
|
736
|
-
* @deprecated Use
|
|
371
|
+
* @deprecated Use `tickers.isPaused` from `@drincs/pixi-vn` instead.
|
|
737
372
|
* Check if a ticker is paused.
|
|
738
373
|
* @param alias The alias of the canvas element that will use the ticker.
|
|
739
374
|
* @param tickerId The ticker that will be checked.
|
|
@@ -742,8 +377,9 @@ interface CanvasManagerInterface {
|
|
|
742
377
|
isTickerPaused(alias: string, tickerId?: string): boolean;
|
|
743
378
|
/**
|
|
744
379
|
* Namespace for operations on canvas tickers.
|
|
380
|
+
* @deprecated Use the top-level `tickers` module (`@drincs/pixi-vn`) instead.
|
|
745
381
|
*/
|
|
746
|
-
readonly tickers:
|
|
382
|
+
readonly tickers: TickersInterface;
|
|
747
383
|
/**
|
|
748
384
|
* Pause the rendering of gameLayer and pause currently running tickers.
|
|
749
385
|
* Use {@link resume} to restore rendering and resume only
|
|
@@ -759,7 +395,7 @@ interface CanvasManagerInterface {
|
|
|
759
395
|
* Add a ticker that must be completed before the next step.
|
|
760
396
|
* This method is used for example into a transition between scenes.
|
|
761
397
|
* @param step The step that the ticker must be completed before the next step.
|
|
762
|
-
* @deprecated Use
|
|
398
|
+
* @deprecated Use `tickers.completeOnStepEnd` from `@drincs/pixi-vn` instead.
|
|
763
399
|
*/
|
|
764
400
|
completeTickerOnStepEnd(step: {
|
|
765
401
|
/**
|
|
@@ -776,7 +412,7 @@ interface CanvasManagerInterface {
|
|
|
776
412
|
* This funcions is called in the next step.
|
|
777
413
|
* @param id The id of the ticker. If the alias provided, the id is the id of the sequence of tickers.
|
|
778
414
|
* @param alias The alias of the sequence of tickers.
|
|
779
|
-
* @deprecated Use
|
|
415
|
+
* @deprecated Use `tickers.forceCompletion` from `@drincs/pixi-vn` instead.
|
|
780
416
|
*/
|
|
781
417
|
forceCompletionOfTicker(id: string, alias?: string): Promise<void>;
|
|
782
418
|
/**
|
|
@@ -904,7 +540,7 @@ interface CanvasManagerInterface {
|
|
|
904
540
|
*/
|
|
905
541
|
restore(data: object): Promise<void>;
|
|
906
542
|
/**
|
|
907
|
-
* @deprecated Use
|
|
543
|
+
* @deprecated Use `tickers.onComplete` from `@drincs/pixi-vn` instead.
|
|
908
544
|
*/
|
|
909
545
|
onTickerComplete(tickerId: string, options: {
|
|
910
546
|
aliasToRemoveAfter: string[];
|
|
@@ -1365,32 +1001,6 @@ declare class CanvasManagerStatic {
|
|
|
1365
1001
|
* The order of the elements in the canvas, is determined by the zIndex.
|
|
1366
1002
|
*/
|
|
1367
1003
|
static get childrenAliasesOrder(): string[];
|
|
1368
|
-
/** Edit Tickers Methods */
|
|
1369
|
-
static get currentTickersWithoutCreatedBySteps(): {
|
|
1370
|
-
[k: string]: TickerHistory<any>;
|
|
1371
|
-
};
|
|
1372
|
-
static readonly _currentTickers: Map<string, TickerInfo<any>>;
|
|
1373
|
-
static readonly _currentTickersSequence: Map<string, Map<string, TickersSequence>>;
|
|
1374
|
-
static get currentTickersSequence(): {
|
|
1375
|
-
[alias: string]: {
|
|
1376
|
-
[tickerId: string]: TickersSequence;
|
|
1377
|
-
};
|
|
1378
|
-
};
|
|
1379
|
-
static readonly _currentTickersTimeouts: Map<string, TickerTimeoutHistory>;
|
|
1380
|
-
static readonly _tickersToCompleteOnStepEnd: {
|
|
1381
|
-
tikersIds: {
|
|
1382
|
-
id: string;
|
|
1383
|
-
}[];
|
|
1384
|
-
stepAlias: {
|
|
1385
|
-
id: string;
|
|
1386
|
-
alias: string;
|
|
1387
|
-
}[];
|
|
1388
|
-
};
|
|
1389
|
-
static generateTickerId(...args: any[]): string;
|
|
1390
|
-
static addTickerTimeoutInfo(aliases: string | string[], ticker: string, timeout: string, canBeDeletedBeforeEnd: boolean): void;
|
|
1391
|
-
static removeTickerTimeoutInfo(timeout: NodeJS.Timeout | string): void;
|
|
1392
|
-
static removeTickerTimeout(timeout: NodeJS.Timeout | string): void;
|
|
1393
|
-
static removeTickerTimeoutsByAlias(alias: string, checkCanBeDeletedBeforeEnd: boolean): void;
|
|
1394
1004
|
}
|
|
1395
1005
|
|
|
1396
1006
|
/**
|
|
@@ -1510,7 +1120,7 @@ declare function canvasComponentDecorator<M extends CanvasBaseItemMemory, T exte
|
|
|
1510
1120
|
*/
|
|
1511
1121
|
copyProperty?: (component: CanvasBaseItem<M>, memory: M) => void | Promise<void>;
|
|
1512
1122
|
}): (target: T) => void;
|
|
1513
|
-
declare function setMemoryContainer<T extends Container$1>(element: T | Container$1, memory:
|
|
1123
|
+
declare function setMemoryContainer<T extends Container$1>(element: T | Container$1, memory: Partial<ContainerMemory> | {}, options?: {
|
|
1514
1124
|
ignoreScale?: boolean;
|
|
1515
1125
|
end?: () => Promise<void> | void;
|
|
1516
1126
|
}): Promise<void>;
|
|
@@ -1621,70 +1231,524 @@ declare namespace RegisteredEvents {
|
|
|
1621
1231
|
}
|
|
1622
1232
|
|
|
1623
1233
|
/**
|
|
1624
|
-
*
|
|
1625
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1626
|
-
* @param alias The alias to identify the component.
|
|
1627
|
-
* @param options Animation options, matching the `options` of animate function.
|
|
1628
|
-
* @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
|
|
1629
|
-
* @returns
|
|
1234
|
+
* @deprecated Use `effects.shakeEffect` instead.
|
|
1630
1235
|
*/
|
|
1631
1236
|
declare function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1632
|
-
|
|
1633
|
-
declare namespace CanvasPropertyUtility {
|
|
1634
|
-
function calculatePositionByAlign(type: "width" | "height", align: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
|
|
1635
|
-
function calculateAlignByPosition(type: "width" | "height", position: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
|
|
1636
|
-
function calculatePositionByPercentagePosition(type: "width" | "height", percentage: number): number;
|
|
1637
|
-
function calculatePercentagePositionByPosition(type: "width" | "height", position: number): number;
|
|
1638
|
-
function getSuperPoint(point: {
|
|
1639
|
-
x: number;
|
|
1640
|
-
y: number;
|
|
1641
|
-
}, angle: number): {
|
|
1642
|
-
x: number;
|
|
1643
|
-
y: number;
|
|
1644
|
-
};
|
|
1645
|
-
function getPointBySuperPoint(superPoint: {
|
|
1646
|
-
x: number;
|
|
1647
|
-
y: number;
|
|
1648
|
-
}, angle: number): {
|
|
1649
|
-
x: number;
|
|
1650
|
-
y: number;
|
|
1651
|
-
};
|
|
1652
|
-
function getSuperWidth(canvasElement: Container$1): number;
|
|
1653
|
-
function getSuperHeight(canvasElement: Container$1): number;
|
|
1654
|
-
}
|
|
1655
|
-
|
|
1656
|
-
interface BaseTransitionProps {
|
|
1237
|
+
declare namespace effects {
|
|
1657
1238
|
/**
|
|
1658
|
-
*
|
|
1659
|
-
*
|
|
1660
|
-
* @
|
|
1239
|
+
* Shake the canvas element.
|
|
1240
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1241
|
+
* @param alias The alias to identify the component.
|
|
1242
|
+
* @param options Animation options, matching the `options` of animate function.
|
|
1243
|
+
* @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
|
|
1244
|
+
* @returns
|
|
1661
1245
|
*/
|
|
1662
|
-
|
|
1663
|
-
}
|
|
1664
|
-
interface ShowWithDissolveTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1665
|
-
}
|
|
1666
|
-
interface ShowWithFadeTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1667
|
-
}
|
|
1668
|
-
interface MoveInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1246
|
+
function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1669
1247
|
/**
|
|
1670
|
-
*
|
|
1671
|
-
* @
|
|
1248
|
+
* Bounce the canvas element: a one-directional displacement that repeatedly returns to rest, each
|
|
1249
|
+
* bounce shrinking towards rest by {@link BounceEffectProps.decay}. Like a dropped ball settling.
|
|
1250
|
+
* @param alias The alias to identify the component.
|
|
1251
|
+
* @param options Animation options.
|
|
1252
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1672
1253
|
*/
|
|
1673
|
-
|
|
1674
|
-
}
|
|
1675
|
-
interface ZoomInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1254
|
+
function bounceEffect(alias: string, options?: BounceEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1676
1255
|
/**
|
|
1677
|
-
*
|
|
1678
|
-
* @
|
|
1256
|
+
* Pulse the canvas element: a repeated, decaying scale bump away from its current scale and back.
|
|
1257
|
+
* @param alias The alias to identify the component.
|
|
1258
|
+
* @param options Animation options.
|
|
1259
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1679
1260
|
*/
|
|
1680
|
-
|
|
1681
|
-
}
|
|
1682
|
-
interface PushInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1261
|
+
function pulseEffect(alias: string, options?: PulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1683
1262
|
/**
|
|
1684
|
-
*
|
|
1263
|
+
* Hop the canvas element: one deliberate displacement-and-return, optionally followed by smaller,
|
|
1264
|
+
* decaying secondary hops.
|
|
1265
|
+
* @param alias The alias to identify the component.
|
|
1266
|
+
* @param options Animation options.
|
|
1267
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1268
|
+
*/
|
|
1269
|
+
function hopEffect(alias: string, options?: HopEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1270
|
+
/**
|
|
1271
|
+
* Wiggle the canvas element: a decaying rotation oscillation around its current angle.
|
|
1272
|
+
* @param alias The alias to identify the component.
|
|
1273
|
+
* @param options Animation options.
|
|
1274
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1275
|
+
*/
|
|
1276
|
+
function wiggleEffect(alias: string, options?: WiggleEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Nod the canvas element: a decaying positional oscillation along one axis.
|
|
1279
|
+
* @param alias The alias to identify the component.
|
|
1280
|
+
* @param options Animation options.
|
|
1281
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1282
|
+
*/
|
|
1283
|
+
function nodEffect(alias: string, options?: NodEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Sway the canvas element: a smooth, optionally combined positional and rotational drift around its
|
|
1286
|
+
* current state - a gentler, slower cousin of {@link nodEffect}/{@link wiggleEffect}.
|
|
1287
|
+
* @param alias The alias to identify the component.
|
|
1288
|
+
* @param options Animation options.
|
|
1289
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1290
|
+
*/
|
|
1291
|
+
function swayEffect(alias: string, options?: SwayEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1292
|
+
/**
|
|
1293
|
+
* Punch the canvas element: a single fast impulse (position, rotation, or scale) with a strong
|
|
1294
|
+
* attack and a short, slightly overshooting recovery back to rest - unlike every other effect here,
|
|
1295
|
+
* this is a one-shot impact, not a repeated oscillation.
|
|
1296
|
+
* @param alias The alias to identify the component.
|
|
1297
|
+
* @param options Animation options.
|
|
1298
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1299
|
+
*/
|
|
1300
|
+
function punchEffect(alias: string, options?: PunchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1301
|
+
/**
|
|
1302
|
+
* Glitch the canvas element: decaying, jittery bursts of digital-corruption slice displacement
|
|
1303
|
+
* ({@link https://pixijs.io/filters/docs/GlitchFilter.html GlitchFilter}) - each burst snaps,
|
|
1304
|
+
* kicks back the other way and settles - with a matching red/blue channel split layered on top
|
|
1305
|
+
* ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}, see
|
|
1306
|
+
* {@link GlitchEffectProps.rgbSplit}). Both filters are removed once done. Returns one ticker id
|
|
1307
|
+
* per filter.
|
|
1308
|
+
*
|
|
1309
|
+
* Known cosmetic quirk: `GlitchFilter`'s own `destroy()` (called once this effect completes, to
|
|
1310
|
+
* clean up its displacement texture) can log a harmless `PixiJS Warning: [BindGroup] a
|
|
1311
|
+
* 'textureSource'/'textureSampler' was destroyed while still bound to a shader` in the console -
|
|
1312
|
+
* this comes from `pixi-filters`' own implementation, not from this effect, doesn't affect the
|
|
1313
|
+
* component's rendering or state, and every property is still correctly restored/detached.
|
|
1314
|
+
* @param alias The alias to identify the component.
|
|
1315
|
+
* @param options Animation options.
|
|
1316
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1317
|
+
*/
|
|
1318
|
+
function glitchEffect(alias: string, options?: GlitchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1319
|
+
/**
|
|
1320
|
+
* Chromatic-aberration the canvas element: the red and blue color channels split apart in opposite
|
|
1321
|
+
* directions and snap back, in a decaying burst
|
|
1322
|
+
* ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}).
|
|
1323
|
+
* @param alias The alias to identify the component.
|
|
1324
|
+
* @param options Animation options.
|
|
1325
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1326
|
+
*/
|
|
1327
|
+
function chromaticAberrationEffect(alias: string, options?: ChromaticAberrationEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Shockwave the canvas element: a single radial ripple distortion travels outward from an origin
|
|
1330
|
+
* point and fades ({@link https://pixijs.io/filters/docs/ShockwaveFilter.html ShockwaveFilter}) -
|
|
1331
|
+
* a one-shot impact, not a repeated oscillation.
|
|
1332
|
+
* @param alias The alias to identify the component.
|
|
1333
|
+
* @param options Animation options.
|
|
1334
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1335
|
+
*/
|
|
1336
|
+
function shockwaveEffect(alias: string, options?: ShockwaveEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Radially blur the canvas element: a decaying burst of zoom-blur radiating from an origin point,
|
|
1339
|
+
* settling back to no blur between and after each burst
|
|
1340
|
+
* ({@link https://pixijs.io/filters/docs/ZoomBlurFilter.html ZoomBlurFilter}).
|
|
1341
|
+
* @param alias The alias to identify the component.
|
|
1342
|
+
* @param options Animation options.
|
|
1343
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1344
|
+
*/
|
|
1345
|
+
function radialBlurEffect(alias: string, options?: RadialBlurEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1346
|
+
/**
|
|
1347
|
+
* Pulse a blur on the canvas element: a repeated, decaying blur bump that settles back to no blur
|
|
1348
|
+
* between and after each pulse ({@link https://pixijs.io/filters/docs/BlurFilter.html BlurFilter}).
|
|
1349
|
+
* @param alias The alias to identify the component.
|
|
1350
|
+
* @param options Animation options.
|
|
1351
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1352
|
+
*/
|
|
1353
|
+
function blurPulseEffect(alias: string, options?: BlurPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1354
|
+
/**
|
|
1355
|
+
* Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying
|
|
1356
|
+
* pulse - built on {@link https://pixijs.io/filters/docs/CRTFilter.html CRTFilter} with its
|
|
1357
|
+
* scanline/noise features turned off, isolating just the vignette.
|
|
1358
|
+
*
|
|
1359
|
+
* The vignette darkens the corners of the element's own bounding rectangle, so it's meant for
|
|
1360
|
+
* backgrounds and other full-frame images; on a sprite with transparent corners (a character, a
|
|
1361
|
+
* shape) there's little to darken and it barely shows.
|
|
1362
|
+
* @param alias The alias to identify the component.
|
|
1363
|
+
* @param options Animation options.
|
|
1364
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1365
|
+
*/
|
|
1366
|
+
function vignettePulseEffect(alias: string, options?: VignettePulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1367
|
+
/**
|
|
1368
|
+
* Desaturate the canvas element: color drains out to {@link DesaturateEffectProps.amount} and
|
|
1369
|
+
* recovers back to normal - a single dip, not a repeated oscillation
|
|
1370
|
+
* ({@link https://pixijs.io/filters/docs/AdjustmentFilter.html AdjustmentFilter}).
|
|
1371
|
+
* @param alias The alias to identify the component.
|
|
1372
|
+
* @param options Animation options.
|
|
1373
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1374
|
+
*/
|
|
1375
|
+
function desaturateEffect(alias: string, options?: DesaturateEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1376
|
+
/**
|
|
1377
|
+
* Pulse a glow on the canvas element: a repeated, decaying outward glow that settles back to no
|
|
1378
|
+
* glow between and after each pulse ({@link https://pixijs.io/filters/docs/GlowFilter.html GlowFilter}).
|
|
1379
|
+
* @param alias The alias to identify the component.
|
|
1380
|
+
* @param options Animation options.
|
|
1381
|
+
* @param priority The priority of the PixiJS ticker.
|
|
1382
|
+
*/
|
|
1383
|
+
function glowPulseEffect(alias: string, options?: GlowPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1386
|
+
declare namespace CanvasPropertyUtility {
|
|
1387
|
+
function calculatePositionByAlign(type: "width" | "height", align: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
|
|
1388
|
+
function calculateAlignByPosition(type: "width" | "height", position: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
|
|
1389
|
+
function calculatePositionByPercentagePosition(type: "width" | "height", percentage: number): number;
|
|
1390
|
+
function calculatePercentagePositionByPosition(type: "width" | "height", position: number): number;
|
|
1391
|
+
function getSuperPoint(point: {
|
|
1392
|
+
x: number;
|
|
1393
|
+
y: number;
|
|
1394
|
+
}, angle: number): {
|
|
1395
|
+
x: number;
|
|
1396
|
+
y: number;
|
|
1397
|
+
};
|
|
1398
|
+
function getPointBySuperPoint(superPoint: {
|
|
1399
|
+
x: number;
|
|
1400
|
+
y: number;
|
|
1401
|
+
}, angle: number): {
|
|
1402
|
+
x: number;
|
|
1403
|
+
y: number;
|
|
1404
|
+
};
|
|
1405
|
+
function getSuperWidth(canvasElement: Container$1): number;
|
|
1406
|
+
function getSuperHeight(canvasElement: Container$1): number;
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
interface RgbColorType {
|
|
1410
|
+
r: number;
|
|
1411
|
+
g: number;
|
|
1412
|
+
b: number;
|
|
1413
|
+
}
|
|
1414
|
+
interface RgbaColorType extends RgbColorType {
|
|
1415
|
+
a: number;
|
|
1416
|
+
}
|
|
1417
|
+
interface HslColorType {
|
|
1418
|
+
h: number;
|
|
1419
|
+
s: number;
|
|
1420
|
+
l: number;
|
|
1421
|
+
}
|
|
1422
|
+
interface HslaColorType extends HslColorType {
|
|
1423
|
+
a: number;
|
|
1424
|
+
}
|
|
1425
|
+
interface HsvColorType {
|
|
1426
|
+
h: number;
|
|
1427
|
+
s: number;
|
|
1428
|
+
v: number;
|
|
1429
|
+
}
|
|
1430
|
+
interface HsvaColorType extends HsvColorType {
|
|
1431
|
+
a: number;
|
|
1432
|
+
}
|
|
1433
|
+
/**
|
|
1434
|
+
* A color, accepted wherever Pixi'VN takes one (e.g. {@link FlashInOutProps.color}): a hex number
|
|
1435
|
+
* (`0xff0000`), a CSS-style string (`"#f00"`, `"red"`, `"rgb(255, 0, 0)"`, ...), an `[r, g, b]`/
|
|
1436
|
+
* `[r, g, b, a]` array, or one of the plain RGB(A)/HSL(A)/HSV(A) object shapes above.
|
|
1437
|
+
*
|
|
1438
|
+
* This is a JSON-serializable subset of `pixi.js`'s own `ColorSource` (which every value here is
|
|
1439
|
+
* still assignable to, so it can be passed straight into `Graphics.fill()`/`tint`/etc. unchanged) -
|
|
1440
|
+
* deliberately excluding `Float32Array`/`Uint8Array`/`Uint8ClampedArray` (which survive a
|
|
1441
|
+
* `JSON.stringify`/`JSON.parse` round-trip but lose their typed-array-ness, coming back as a plain
|
|
1442
|
+
* `{0: r, 1: g, ...}` object) and PixiJS's own `Color` class instance (not serializable at all). Both
|
|
1443
|
+
* would break `createExportableElement()` (ticker args, saved game state, ...) the same way a live
|
|
1444
|
+
* `Filter`/callback reference did elsewhere in the codebase.
|
|
1445
|
+
*/
|
|
1446
|
+
type ColorType = string | number | number[] | RgbColorType | RgbaColorType | HslColorType | HslaColorType | HsvColorType | HsvaColorType;
|
|
1447
|
+
|
|
1448
|
+
interface BaseTransitionProps {
|
|
1449
|
+
/**
|
|
1450
|
+
* If true, the transition will be completed before the next step.
|
|
1451
|
+
* For example, if the transition is a dissolve transition, the "alpha" of the texture will be 1 before the next step.
|
|
1452
|
+
* @default true
|
|
1453
|
+
*/
|
|
1454
|
+
completeOnContinue?: boolean;
|
|
1455
|
+
}
|
|
1456
|
+
interface ShowWithDissolveTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1457
|
+
}
|
|
1458
|
+
interface ShowWithFadeTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1459
|
+
}
|
|
1460
|
+
interface MoveInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1461
|
+
/**
|
|
1462
|
+
* The direction of the movement.
|
|
1685
1463
|
* @default "right"
|
|
1686
1464
|
*/
|
|
1687
1465
|
direction?: "up" | "down" | "left" | "right";
|
|
1466
|
+
/**
|
|
1467
|
+
* Adds a motion-blur trail along the movement, ramping up mid-move and back to sharp at the end.
|
|
1468
|
+
* `true` uses a 40px trail; a number sets the trail length (pixels).
|
|
1469
|
+
* @default false
|
|
1470
|
+
*/
|
|
1471
|
+
motionBlur?: boolean | number;
|
|
1472
|
+
}
|
|
1473
|
+
interface ZoomInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1474
|
+
/**
|
|
1475
|
+
* The direction of the zoom effect.
|
|
1476
|
+
* @default "right"
|
|
1477
|
+
*/
|
|
1478
|
+
direction?: "up" | "down" | "left" | "right";
|
|
1479
|
+
}
|
|
1480
|
+
interface PushInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1481
|
+
/**
|
|
1482
|
+
* The direction of the push effect.
|
|
1483
|
+
* @default "right"
|
|
1484
|
+
*/
|
|
1485
|
+
direction?: "up" | "down" | "left" | "right";
|
|
1486
|
+
/**
|
|
1487
|
+
* Adds a motion-blur trail along the movement, ramping up mid-move and back to sharp at the end.
|
|
1488
|
+
* `true` uses a 40px trail; a number sets the trail length (pixels).
|
|
1489
|
+
* @default false
|
|
1490
|
+
*/
|
|
1491
|
+
motionBlur?: boolean | number;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* Shared options for the mask-based reveal/conceal transitions ({@link WipeInOutProps},
|
|
1495
|
+
* {@link IrisInOutProps}, {@link SplitInOutProps}).
|
|
1496
|
+
*/
|
|
1497
|
+
interface MaskTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1498
|
+
/**
|
|
1499
|
+
* If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.
|
|
1500
|
+
* @default false
|
|
1501
|
+
*/
|
|
1502
|
+
invert?: boolean;
|
|
1503
|
+
}
|
|
1504
|
+
interface WipeInOutProps extends MaskTransitionProps {
|
|
1505
|
+
/**
|
|
1506
|
+
* The angle (in degrees) the wipe boundary sweeps towards. `0` is left-to-right, `90` is
|
|
1507
|
+
* bottom-to-top, `180` is right-to-left, `270` is top-to-bottom, and any other value produces a
|
|
1508
|
+
* diagonal wipe.
|
|
1509
|
+
* @default 0
|
|
1510
|
+
*/
|
|
1511
|
+
angle?: number;
|
|
1512
|
+
/**
|
|
1513
|
+
* A convenience shorthand for {@link angle}: `"right"` (`0`), `"up"` (`90`), `"left"` (`180`),
|
|
1514
|
+
* `"down"` (`270`). Ignored if `angle` is also set.
|
|
1515
|
+
* @default "right"
|
|
1516
|
+
*/
|
|
1517
|
+
direction?: "up" | "down" | "left" | "right";
|
|
1518
|
+
}
|
|
1519
|
+
interface IrisInOutProps extends MaskTransitionProps {
|
|
1520
|
+
/**
|
|
1521
|
+
* The origin of the iris, normalized to the component's own bounds (`0` to `1` on each axis).
|
|
1522
|
+
* @default { x: 0.5, y: 0.5 }
|
|
1523
|
+
*/
|
|
1524
|
+
origin?: Partial<PointData>;
|
|
1525
|
+
/**
|
|
1526
|
+
* The aspect ratio (width / height) of the iris shape. `1` (the default) is a circle.
|
|
1527
|
+
* @default 1
|
|
1528
|
+
*/
|
|
1529
|
+
aspect?: number;
|
|
1530
|
+
}
|
|
1531
|
+
interface SplitInOutProps extends MaskTransitionProps {
|
|
1532
|
+
/**
|
|
1533
|
+
* The axis the two mask panels move apart on/towards.
|
|
1534
|
+
* @default "vertical"
|
|
1535
|
+
*/
|
|
1536
|
+
orientation?: "horizontal" | "vertical";
|
|
1537
|
+
/**
|
|
1538
|
+
* The origin of the split line, normalized to the component's own bounds (`0` to `1` on the axis
|
|
1539
|
+
* perpendicular to {@link orientation}).
|
|
1540
|
+
* @default 0.5
|
|
1541
|
+
*/
|
|
1542
|
+
origin?: number;
|
|
1543
|
+
}
|
|
1544
|
+
interface FlashInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1545
|
+
/**
|
|
1546
|
+
* The overlay color. See {@link ColorType}.
|
|
1547
|
+
* @default 0xffffff
|
|
1548
|
+
*/
|
|
1549
|
+
color?: ColorType;
|
|
1550
|
+
/**
|
|
1551
|
+
* The peak alpha the overlay reaches.
|
|
1552
|
+
* @default 1
|
|
1553
|
+
*/
|
|
1554
|
+
maxAlpha?: number;
|
|
1555
|
+
/**
|
|
1556
|
+
* How long (in seconds) the overlay stays at {@link maxAlpha} before fading again.
|
|
1557
|
+
* @default 0
|
|
1558
|
+
*/
|
|
1559
|
+
holdDuration?: number;
|
|
1560
|
+
/**
|
|
1561
|
+
* The number of times the overlay fades in and out.
|
|
1562
|
+
* @default 1
|
|
1563
|
+
*/
|
|
1564
|
+
pulses?: number;
|
|
1565
|
+
/**
|
|
1566
|
+
* Whether the component itself also briefly fades in (`flashIn`) or out (`flashOut`) alongside the
|
|
1567
|
+
* color flash, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a
|
|
1568
|
+
* quarter of the flash's own duration, mirrored to the start of `flashIn`'s cycle or the end of
|
|
1569
|
+
* `flashOut`'s. Ignored when `flashIn` replaces an existing component (both sides are already
|
|
1570
|
+
* hidden under a solid `color` at the moment of the swap, so there's no pop to soften).
|
|
1571
|
+
* @default true
|
|
1572
|
+
*/
|
|
1573
|
+
fadeComponent?: boolean;
|
|
1574
|
+
}
|
|
1575
|
+
interface BlurInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1576
|
+
/**
|
|
1577
|
+
* The blur strength the effect starts from (`blurIn`) or ends at (`blurOut`).
|
|
1578
|
+
* @default 32
|
|
1579
|
+
*/
|
|
1580
|
+
strength?: number;
|
|
1581
|
+
/**
|
|
1582
|
+
* The quality (number of blur passes) of the blur filter. Higher is smoother but slower.
|
|
1583
|
+
* @default 4
|
|
1584
|
+
*/
|
|
1585
|
+
quality?: number;
|
|
1586
|
+
/**
|
|
1587
|
+
* Whether the component itself also briefly fades in (`blurIn`) or out (`blurOut`) alongside the
|
|
1588
|
+
* blur, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a quarter of
|
|
1589
|
+
* the effect's own duration, mirrored to the start of `blurIn` or the end of `blurOut`.
|
|
1590
|
+
* @default true
|
|
1591
|
+
*/
|
|
1592
|
+
fadeComponent?: boolean;
|
|
1593
|
+
}
|
|
1594
|
+
interface PixelateInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1595
|
+
/**
|
|
1596
|
+
* The pixel size the effect starts from (`pixelateIn`) or ends at (`pixelateOut`).
|
|
1597
|
+
* @default 32
|
|
1598
|
+
*/
|
|
1599
|
+
pixelSize?: number;
|
|
1600
|
+
/**
|
|
1601
|
+
* Whether the component itself also briefly fades in (`pixelateIn`) or out (`pixelateOut`) alongside
|
|
1602
|
+
* the pixelation, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a
|
|
1603
|
+
* quarter of the effect's own duration, mirrored to the start of `pixelateIn` or the end of
|
|
1604
|
+
* `pixelateOut`. Off by default: pixelation itself already reads as a deliberate, blocky
|
|
1605
|
+
* appear/disappear, so a softening fade is less often wanted here than for blur/flash.
|
|
1606
|
+
* @default false
|
|
1607
|
+
*/
|
|
1608
|
+
fadeComponent?: boolean;
|
|
1609
|
+
}
|
|
1610
|
+
/**
|
|
1611
|
+
* Shared options for the filter-based reveal/conceal transitions ({@link GlitchInOutProps},
|
|
1612
|
+
* {@link TwistInOutProps}, {@link WarpInOutProps}, {@link RippleInOutProps},
|
|
1613
|
+
* {@link NoiseDissolveInOutProps}, {@link PinchInOutProps}).
|
|
1614
|
+
*/
|
|
1615
|
+
interface FilterFadeTransitionProps extends BaseTransitionProps, AnimationOptions {
|
|
1616
|
+
/**
|
|
1617
|
+
* Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
|
|
1618
|
+
* at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
|
|
1619
|
+
* (same behavior as {@link BlurInOutProps.fadeComponent}). The default depends on the transition.
|
|
1620
|
+
*/
|
|
1621
|
+
fadeComponent?: boolean;
|
|
1622
|
+
}
|
|
1623
|
+
interface GlitchInOutProps extends FilterFadeTransitionProps {
|
|
1624
|
+
/**
|
|
1625
|
+
* The peak slice-displacement (pixels) - the first burst of `glitchIn`, the last of `glitchOut`.
|
|
1626
|
+
* @default 40
|
|
1627
|
+
*/
|
|
1628
|
+
strength?: number;
|
|
1629
|
+
/**
|
|
1630
|
+
* The number of glitch bursts.
|
|
1631
|
+
* @default 3
|
|
1632
|
+
*/
|
|
1633
|
+
bursts?: number;
|
|
1634
|
+
/**
|
|
1635
|
+
* The number of glitch slices.
|
|
1636
|
+
* @default 8
|
|
1637
|
+
*/
|
|
1638
|
+
slices?: number;
|
|
1639
|
+
/**
|
|
1640
|
+
* The peak red/blue channel separation (pixels) layered on top of the slices, following the same
|
|
1641
|
+
* envelope. `0` disables it.
|
|
1642
|
+
* @default 6
|
|
1643
|
+
*/
|
|
1644
|
+
rgbSplit?: number;
|
|
1645
|
+
}
|
|
1646
|
+
interface TwistInOutProps extends FilterFadeTransitionProps {
|
|
1647
|
+
/**
|
|
1648
|
+
* How far (degrees) the swirl is wound up - where `twistIn` starts and `twistOut` ends.
|
|
1649
|
+
* @default 540
|
|
1650
|
+
*/
|
|
1651
|
+
angle?: number;
|
|
1652
|
+
/**
|
|
1653
|
+
* The radius (pixels) of the swirl. Defaults to half the component's diagonal, so the whole
|
|
1654
|
+
* component swirls.
|
|
1655
|
+
*/
|
|
1656
|
+
radius?: number;
|
|
1657
|
+
/**
|
|
1658
|
+
* The center of the swirl, normalized to the component's own bounds (`0` to `1` on each axis).
|
|
1659
|
+
* @default { x: 0.5, y: 0.5 }
|
|
1660
|
+
*/
|
|
1661
|
+
origin?: Partial<PointData>;
|
|
1662
|
+
}
|
|
1663
|
+
interface WarpInOutProps extends FilterFadeTransitionProps {
|
|
1664
|
+
/**
|
|
1665
|
+
* The zoom-blur strength `warpIn` starts from and `warpOut` ends at.
|
|
1666
|
+
* @default 0.6
|
|
1667
|
+
*/
|
|
1668
|
+
strength?: number;
|
|
1669
|
+
/**
|
|
1670
|
+
* The point the streaks radiate from, normalized to the component's own bounds.
|
|
1671
|
+
* @default { x: 0.5, y: 0.5 }
|
|
1672
|
+
*/
|
|
1673
|
+
origin?: Partial<PointData>;
|
|
1674
|
+
}
|
|
1675
|
+
interface RippleInOutProps extends FilterFadeTransitionProps {
|
|
1676
|
+
/**
|
|
1677
|
+
* The point the ripple starts from, normalized to the component's own bounds.
|
|
1678
|
+
* @default { x: 0.5, y: 0.5 }
|
|
1679
|
+
*/
|
|
1680
|
+
origin?: Partial<PointData>;
|
|
1681
|
+
/**
|
|
1682
|
+
* The amplitude of the ripple.
|
|
1683
|
+
* @default 30
|
|
1684
|
+
*/
|
|
1685
|
+
amplitude?: number;
|
|
1686
|
+
/**
|
|
1687
|
+
* The wavelength of the ripple.
|
|
1688
|
+
* @default 160
|
|
1689
|
+
*/
|
|
1690
|
+
wavelength?: number;
|
|
1691
|
+
/**
|
|
1692
|
+
* The speed (pixels-per-second, in the ripple's own time) the ring travels outward. The ring always
|
|
1693
|
+
* travels until it has left the component; `speed` only shapes the ring.
|
|
1694
|
+
* @default 500
|
|
1695
|
+
*/
|
|
1696
|
+
speed?: number;
|
|
1697
|
+
}
|
|
1698
|
+
interface NoiseDissolveInOutProps extends FilterFadeTransitionProps {
|
|
1699
|
+
/**
|
|
1700
|
+
* `"hard"`: the component appears/disappears in crisp noise-shaped blotches. `"soft"`: a cloudy,
|
|
1701
|
+
* gradual dissolve.
|
|
1702
|
+
* @default "hard"
|
|
1703
|
+
*/
|
|
1704
|
+
edge?: "hard" | "soft";
|
|
1705
|
+
/**
|
|
1706
|
+
* The scale of the noise pattern - higher values give smaller, more numerous blotches.
|
|
1707
|
+
* @default 8
|
|
1708
|
+
*/
|
|
1709
|
+
noiseScale?: number;
|
|
1710
|
+
/**
|
|
1711
|
+
* Picks the noise pattern. Random by default, so every dissolve looks different.
|
|
1712
|
+
*/
|
|
1713
|
+
seed?: number;
|
|
1714
|
+
}
|
|
1715
|
+
interface TvInOutProps extends BaseTransitionProps, AnimationOptions {
|
|
1716
|
+
/**
|
|
1717
|
+
* The height of the collapsed bright line, as a fraction of the component's own height.
|
|
1718
|
+
* @default 0.02
|
|
1719
|
+
*/
|
|
1720
|
+
lineThickness?: number;
|
|
1721
|
+
/**
|
|
1722
|
+
* How bright the collapsed line glows (`1` = no change).
|
|
1723
|
+
* @default 3
|
|
1724
|
+
*/
|
|
1725
|
+
brightness?: number;
|
|
1726
|
+
/**
|
|
1727
|
+
* Whether CRT scanlines/noise are shown during the transition.
|
|
1728
|
+
* @default true
|
|
1729
|
+
*/
|
|
1730
|
+
scanlines?: boolean;
|
|
1731
|
+
}
|
|
1732
|
+
interface PinchInOutProps extends FilterFadeTransitionProps {
|
|
1733
|
+
/**
|
|
1734
|
+
* How strong the deformation is, from `0` to `1` - where `pinchIn` starts and `pinchOut` ends.
|
|
1735
|
+
* @default 1
|
|
1736
|
+
*/
|
|
1737
|
+
strength?: number;
|
|
1738
|
+
/**
|
|
1739
|
+
* `"pinch"`: sucked into/out of a point. `"bulge"`: puffed out from/into a point.
|
|
1740
|
+
* @default "pinch"
|
|
1741
|
+
*/
|
|
1742
|
+
mode?: "pinch" | "bulge";
|
|
1743
|
+
/**
|
|
1744
|
+
* The radius (pixels) of the deformation. Defaults to half the component's diagonal.
|
|
1745
|
+
*/
|
|
1746
|
+
radius?: number;
|
|
1747
|
+
/**
|
|
1748
|
+
* The center of the deformation, normalized to the component's own bounds.
|
|
1749
|
+
* @default { x: 0.5, y: 0.5 }
|
|
1750
|
+
*/
|
|
1751
|
+
origin?: Partial<PointData>;
|
|
1688
1752
|
}
|
|
1689
1753
|
|
|
1690
1754
|
type TComponent = CanvasBaseInterface<any> | string | string[] | {
|
|
@@ -1695,61 +1759,23 @@ type TComponent = CanvasBaseInterface<any> | string | string[] | {
|
|
|
1695
1759
|
options: ImageContainerOptions;
|
|
1696
1760
|
};
|
|
1697
1761
|
/**
|
|
1698
|
-
*
|
|
1699
|
-
* Disolve effect is a effect that the image is shown with a fade in.
|
|
1700
|
-
* If exist a image with the same alias, then the image is replaced and the first image is removed after the effect is done.
|
|
1701
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1702
|
-
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1703
|
-
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1704
|
-
* If you don't provide the component, then the alias is used as the url.
|
|
1705
|
-
* @param props The properties of the effect
|
|
1706
|
-
* @param priority The priority of the effect
|
|
1707
|
-
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1762
|
+
* @deprecated Use `transitions.showWithDissolve` instead.
|
|
1708
1763
|
*/
|
|
1709
1764
|
declare function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1710
1765
|
/**
|
|
1711
|
-
*
|
|
1712
|
-
* Disolve effect is a effect that the image is removed with a fade out.
|
|
1713
|
-
* This function is equivalent to {@link removeWithFade}.
|
|
1714
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1715
|
-
* @param props The properties of the effect
|
|
1716
|
-
* @param priority The priority of the effect
|
|
1717
|
-
* @returns The ids of the tickers that are used in the effect.
|
|
1766
|
+
* @deprecated Use `transitions.removeWithDissolve` instead.
|
|
1718
1767
|
*/
|
|
1719
1768
|
declare function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1720
1769
|
/**
|
|
1721
|
-
*
|
|
1722
|
-
* Fade effect is a effect that the image is shown with a fade in.
|
|
1723
|
-
* If exist a image with the same alias, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
|
|
1724
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1725
|
-
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1726
|
-
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1727
|
-
* If you don't provide the component, then the alias is used as the url.
|
|
1728
|
-
* @param props The properties of the effect
|
|
1729
|
-
* @param priority The priority of the effect
|
|
1730
|
-
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1770
|
+
* @deprecated Use `transitions.showWithFade` instead.
|
|
1731
1771
|
*/
|
|
1732
1772
|
declare function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1733
1773
|
/**
|
|
1734
|
-
*
|
|
1735
|
-
* Fade effect is a effect that the image is removed with a fade out.
|
|
1736
|
-
* This function is equivalent to {@link removeWithDissolve}.
|
|
1737
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1738
|
-
* @param props The properties of the effect
|
|
1739
|
-
* @param priority The priority of the effect
|
|
1740
|
-
* @returns The ids of the tickers that are used in the effect.
|
|
1774
|
+
* @deprecated Use `transitions.removeWithFade` instead.
|
|
1741
1775
|
*/
|
|
1742
1776
|
declare function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1743
1777
|
/**
|
|
1744
|
-
*
|
|
1745
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1746
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1747
|
-
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1748
|
-
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1749
|
-
* If you don't provide the component, then the alias is used as the url.
|
|
1750
|
-
* @param props The properties of the effect
|
|
1751
|
-
* @param priority The priority of the effect
|
|
1752
|
-
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1778
|
+
* @deprecated Use `transitions.moveIn` instead.
|
|
1753
1779
|
*/
|
|
1754
1780
|
declare function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
|
|
1755
1781
|
/**
|
|
@@ -1759,24 +1785,11 @@ declare function moveIn(alias: string, component?: TComponent, props?: MoveInOut
|
|
|
1759
1785
|
removeOldComponentWithMoveOut?: boolean;
|
|
1760
1786
|
}, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1761
1787
|
/**
|
|
1762
|
-
*
|
|
1763
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1764
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1765
|
-
* @param props The properties of the effect
|
|
1766
|
-
* @param priority The priority of the effect
|
|
1767
|
-
* @returns The ids of the tickers that are used in the effect.
|
|
1788
|
+
* @deprecated Use `transitions.moveOut` instead.
|
|
1768
1789
|
*/
|
|
1769
1790
|
declare function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1770
1791
|
/**
|
|
1771
|
-
*
|
|
1772
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1773
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1774
|
-
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1775
|
-
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1776
|
-
* If you don't provide the component, then the alias is used as the url.
|
|
1777
|
-
* @param props The properties of the effect
|
|
1778
|
-
* @param priority The priority of the effect
|
|
1779
|
-
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1792
|
+
* @deprecated Use `transitions.zoomIn` instead.
|
|
1780
1793
|
*/
|
|
1781
1794
|
declare function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
|
|
1782
1795
|
/**
|
|
@@ -1786,35 +1799,419 @@ declare function zoomIn(alias: string, component?: TComponent, props?: ZoomInOut
|
|
|
1786
1799
|
removeOldComponentWithZoomOut?: boolean;
|
|
1787
1800
|
}, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1788
1801
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1791
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1792
|
-
* @param props The properties of the effect
|
|
1793
|
-
* @param priority The priority of the effect
|
|
1794
|
-
* @returns The ids of the tickers that are used in the effect.
|
|
1802
|
+
* @deprecated Use `transitions.zoomOut` instead.
|
|
1795
1803
|
*/
|
|
1796
1804
|
declare function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1797
1805
|
/**
|
|
1798
|
-
*
|
|
1799
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1800
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1801
|
-
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1802
|
-
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1803
|
-
* If you don't provide the component, then the alias is used as the url.
|
|
1804
|
-
* @param props The properties of the effect
|
|
1805
|
-
* @param priority The priority of the effect
|
|
1806
|
-
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1806
|
+
* @deprecated Use `transitions.pushIn` instead.
|
|
1807
1807
|
*/
|
|
1808
1808
|
declare function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1809
1809
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1812
|
-
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1813
|
-
* @param props The properties of the effect
|
|
1814
|
-
* @param priority The priority of the effect
|
|
1815
|
-
* @returns The ids of the tickers that are used in the effect.
|
|
1810
|
+
* @deprecated Use `transitions.pushOut` instead.
|
|
1816
1811
|
*/
|
|
1817
1812
|
declare function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1813
|
+
declare namespace transitions {
|
|
1814
|
+
/**
|
|
1815
|
+
* Show a image in the canvas with a disolve effect.
|
|
1816
|
+
* Disolve effect is a effect that the image is shown with a fade in.
|
|
1817
|
+
* If exist a image with the same alias, then the image is replaced and the first image is removed after the effect is done.
|
|
1818
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1819
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1820
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1821
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1822
|
+
* @param props The properties of the effect
|
|
1823
|
+
* @param priority The priority of the effect
|
|
1824
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1825
|
+
*/
|
|
1826
|
+
function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Remove a image from the canvas with a disolve effect.
|
|
1829
|
+
* Disolve effect is a effect that the image is removed with a fade out.
|
|
1830
|
+
* This function is equivalent to {@link removeWithFade}.
|
|
1831
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1832
|
+
* @param props The properties of the effect
|
|
1833
|
+
* @param priority The priority of the effect
|
|
1834
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1835
|
+
*/
|
|
1836
|
+
function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1837
|
+
/**
|
|
1838
|
+
* Show a image in the canvas with a fade effect.
|
|
1839
|
+
* Fade effect is a effect that the image is shown with a fade in.
|
|
1840
|
+
* If exist a image with the same alias, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
|
|
1841
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1842
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1843
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1844
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1845
|
+
* @param props The properties of the effect
|
|
1846
|
+
* @param priority The priority of the effect
|
|
1847
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1848
|
+
*/
|
|
1849
|
+
function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1850
|
+
/**
|
|
1851
|
+
* Remove a image from the canvas with a fade effect.
|
|
1852
|
+
* Fade effect is a effect that the image is removed with a fade out.
|
|
1853
|
+
* This function is equivalent to {@link removeWithDissolve}.
|
|
1854
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1855
|
+
* @param props The properties of the effect
|
|
1856
|
+
* @param priority The priority of the effect
|
|
1857
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1858
|
+
*/
|
|
1859
|
+
function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1860
|
+
/**
|
|
1861
|
+
* Show a image in the canvas with a move effect. The image is moved from outside the canvas to the x and y position of the image.
|
|
1862
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1863
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1864
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1865
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1866
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1867
|
+
* @param props The properties of the effect
|
|
1868
|
+
* @param priority The priority of the effect
|
|
1869
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1870
|
+
*/
|
|
1871
|
+
function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
|
|
1872
|
+
/**
|
|
1873
|
+
* If true, then the old component is removed with a move out, after the new image is moved in.
|
|
1874
|
+
* @default false
|
|
1875
|
+
*/
|
|
1876
|
+
removeOldComponentWithMoveOut?: boolean;
|
|
1877
|
+
}, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1878
|
+
/**
|
|
1879
|
+
* Remove a image from the canvas with a move effect. The image is moved from the x and y position of the image to outside the canvas.
|
|
1880
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1881
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1882
|
+
* @param props The properties of the effect
|
|
1883
|
+
* @param priority The priority of the effect
|
|
1884
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1885
|
+
*/
|
|
1886
|
+
function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1887
|
+
/**
|
|
1888
|
+
* Show a image in the canvas with a zoom effect. The image is zoomed in from the center of the canvas.
|
|
1889
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1890
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1891
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1892
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1893
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1894
|
+
* @param props The properties of the effect
|
|
1895
|
+
* @param priority The priority of the effect
|
|
1896
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1897
|
+
*/
|
|
1898
|
+
function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
|
|
1899
|
+
/**
|
|
1900
|
+
* If true, then the old component is removed with a zoom out, after the new image is zoomed in.
|
|
1901
|
+
* @default false
|
|
1902
|
+
*/
|
|
1903
|
+
removeOldComponentWithZoomOut?: boolean;
|
|
1904
|
+
}, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1905
|
+
/**
|
|
1906
|
+
* Remove a image from the canvas with a zoom effect. The image is zoomed out to the center of the canvas.
|
|
1907
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1908
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1909
|
+
* @param props The properties of the effect
|
|
1910
|
+
* @param priority The priority of the effect
|
|
1911
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1912
|
+
*/
|
|
1913
|
+
function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* Show a image in the canvas with a push effect. The new image is pushed in from the inside of the canvas and the old image is pushed out to the outside of the canvas.
|
|
1916
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1917
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1918
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1919
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1920
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1921
|
+
* @param props The properties of the effect
|
|
1922
|
+
* @param priority The priority of the effect
|
|
1923
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1924
|
+
*/
|
|
1925
|
+
function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1926
|
+
/**
|
|
1927
|
+
* Remove a image from the canvas with a push effect. The image is pushed out to the outside of the canvas.
|
|
1928
|
+
* If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
|
|
1929
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1930
|
+
* @param props The properties of the effect
|
|
1931
|
+
* @param priority The priority of the effect
|
|
1932
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1933
|
+
*/
|
|
1934
|
+
function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1935
|
+
/**
|
|
1936
|
+
* Show a image in the canvas with a wipe effect: the image is progressively revealed by a moving
|
|
1937
|
+
* boundary. The direction/angle and inversion are all configurable, so the same primitive can
|
|
1938
|
+
* produce horizontal, vertical, or diagonal reveals - see {@link WipeInOutProps}.
|
|
1939
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1940
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1941
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1942
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1943
|
+
* @param props The properties of the effect
|
|
1944
|
+
* @param priority The priority of the effect
|
|
1945
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1946
|
+
*/
|
|
1947
|
+
function wipeIn(alias: string, component?: TComponent, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1948
|
+
/**
|
|
1949
|
+
* Remove a image from the canvas with a wipe effect: the image is progressively concealed by a
|
|
1950
|
+
* moving boundary. See {@link wipeIn} and {@link WipeInOutProps}.
|
|
1951
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1952
|
+
* @param props The properties of the effect
|
|
1953
|
+
* @param priority The priority of the effect
|
|
1954
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1955
|
+
*/
|
|
1956
|
+
function wipeOut(alias: string, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1957
|
+
/**
|
|
1958
|
+
* Show a image in the canvas with an iris effect: the image is progressively revealed by an
|
|
1959
|
+
* expanding radial mask. Moving {@link IrisInOutProps.origin} off-center makes the same primitive
|
|
1960
|
+
* useful as a focus/reveal effect (e.g. centered on a character).
|
|
1961
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1962
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1963
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1964
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1965
|
+
* @param props The properties of the effect
|
|
1966
|
+
* @param priority The priority of the effect
|
|
1967
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1968
|
+
*/
|
|
1969
|
+
function irisIn(alias: string, component?: TComponent, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1970
|
+
/**
|
|
1971
|
+
* Remove a image from the canvas with an iris effect: the image is progressively concealed by a
|
|
1972
|
+
* contracting radial mask. See {@link irisIn} and {@link IrisInOutProps}.
|
|
1973
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1974
|
+
* @param props The properties of the effect
|
|
1975
|
+
* @param priority The priority of the effect
|
|
1976
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1977
|
+
*/
|
|
1978
|
+
function irisOut(alias: string, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
1979
|
+
/**
|
|
1980
|
+
* Show a image in the canvas with a split effect: two mask panels slide together from the edges to
|
|
1981
|
+
* progressively reveal the image, meeting at the split line once fully shown. A configured
|
|
1982
|
+
* {@link SplitInOutProps} covers "curtain"-like effects without a story-specific API.
|
|
1983
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1984
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
1985
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
1986
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
1987
|
+
* @param props The properties of the effect
|
|
1988
|
+
* @param priority The priority of the effect
|
|
1989
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
1990
|
+
*/
|
|
1991
|
+
function splitIn(alias: string, component?: TComponent, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
1992
|
+
/**
|
|
1993
|
+
* Remove a image from the canvas with a split effect: two mask panels retract apart toward the
|
|
1994
|
+
* edges to progressively conceal the image. See {@link splitIn} and {@link SplitInOutProps}.
|
|
1995
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
1996
|
+
* @param props The properties of the effect
|
|
1997
|
+
* @param priority The priority of the effect
|
|
1998
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
1999
|
+
*/
|
|
2000
|
+
function splitOut(alias: string, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2001
|
+
/**
|
|
2002
|
+
* Show a image in the canvas with a blur effect: the image appears already blurred and sharpens
|
|
2003
|
+
* into focus. A generic blur, not a "dream"/"flashback" transition specifically - combine it with
|
|
2004
|
+
* {@link showWithFade} for that recipe. See {@link BlurInOutProps}.
|
|
2005
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2006
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
2007
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
2008
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
2009
|
+
* @param props The properties of the effect
|
|
2010
|
+
* @param priority The priority of the effect
|
|
2011
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2012
|
+
*/
|
|
2013
|
+
function blurIn(alias: string, component?: TComponent, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2014
|
+
/**
|
|
2015
|
+
* Remove a image from the canvas with a blur effect: the image blurs out of focus before being
|
|
2016
|
+
* removed. See {@link blurIn} and {@link BlurInOutProps}.
|
|
2017
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2018
|
+
* @param props The properties of the effect
|
|
2019
|
+
* @param priority The priority of the effect
|
|
2020
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2021
|
+
*/
|
|
2022
|
+
function blurOut(alias: string, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2023
|
+
/**
|
|
2024
|
+
* Show a image in the canvas with a pixelate effect: the image appears pixelated and resolves into
|
|
2025
|
+
* focus. Useful for retro effects, digital transitions, censorship/stylization, or scene changes -
|
|
2026
|
+
* not only "glitch" scenes. See {@link PixelateInOutProps}.
|
|
2027
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2028
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
2029
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
2030
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
2031
|
+
* @param props The properties of the effect
|
|
2032
|
+
* @param priority The priority of the effect
|
|
2033
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2034
|
+
*/
|
|
2035
|
+
function pixelateIn(alias: string, component?: TComponent, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2036
|
+
/**
|
|
2037
|
+
* Remove a image from the canvas with a pixelate effect: the image pixelates before being removed.
|
|
2038
|
+
* See {@link pixelateIn} and {@link PixelateInOutProps}.
|
|
2039
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2040
|
+
* @param props The properties of the effect
|
|
2041
|
+
* @param priority The priority of the effect
|
|
2042
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2043
|
+
*/
|
|
2044
|
+
function pixelateOut(alias: string, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2045
|
+
/**
|
|
2046
|
+
* Show a image in the canvas with a flash effect, with a configurable solid-color overlay (not
|
|
2047
|
+
* limited to a white flash). White reads as a camera/explosion-like flash, black as a blink/cut, and
|
|
2048
|
+
* arbitrary colors work for damage/magic/memory/UI transitions. See {@link FlashInOutProps}.
|
|
2049
|
+
*
|
|
2050
|
+
* If `alias` has no existing component, the new image appears immediately and the overlay fades in
|
|
2051
|
+
* and back out over it. If `alias` already has a component, the *current* content fades up to
|
|
2052
|
+
* `color` first, is swapped for the new content at the exact moment the screen is a solid `color`
|
|
2053
|
+
* (so the content change itself is invisible), and the new content then fades back down from `color`
|
|
2054
|
+
* to normal - see {@link flashReplace}.
|
|
2055
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2056
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
|
|
2057
|
+
* If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
|
|
2058
|
+
* If you don't provide the component, then the alias is used as the url.
|
|
2059
|
+
* @param props The properties of the effect
|
|
2060
|
+
* @param priority The priority of the effect
|
|
2061
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2062
|
+
*/
|
|
2063
|
+
function flashIn(alias: string, component?: TComponent, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2064
|
+
/**
|
|
2065
|
+
* Remove a image from the canvas with a flash effect: a configurable solid-color overlay fades up to
|
|
2066
|
+
* `color` and back down to normal, and the image is removed the instant that finishes - the removal
|
|
2067
|
+
* itself is a hard cut, never an additional fade/dissolve. See {@link flashIn} and
|
|
2068
|
+
* {@link FlashInOutProps}.
|
|
2069
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2070
|
+
* @param props The properties of the effect
|
|
2071
|
+
* @param priority The priority of the effect
|
|
2072
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2073
|
+
*/
|
|
2074
|
+
function flashOut(alias: string, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2075
|
+
/**
|
|
2076
|
+
* Show a image in the canvas with a glitch effect: the image materializes out of jittery bursts of
|
|
2077
|
+
* digital-corruption slices with red/blue fringing, which settle as it appears. See
|
|
2078
|
+
* {@link GlitchInOutProps}.
|
|
2079
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2080
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2081
|
+
* @param props The properties of the effect
|
|
2082
|
+
* @param priority The priority of the effect
|
|
2083
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2084
|
+
*/
|
|
2085
|
+
function glitchIn(alias: string, component?: TComponent, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2086
|
+
/**
|
|
2087
|
+
* Remove a image from the canvas with a glitch effect: digital-corruption bursts build up until the
|
|
2088
|
+
* image is removed. See {@link glitchIn} and {@link GlitchInOutProps}.
|
|
2089
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2090
|
+
* @param props The properties of the effect
|
|
2091
|
+
* @param priority The priority of the effect
|
|
2092
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2093
|
+
*/
|
|
2094
|
+
function glitchOut(alias: string, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2095
|
+
/**
|
|
2096
|
+
* Show a image in the canvas with a twist effect: the image unwinds out of a swirl, like coming
|
|
2097
|
+
* through a vortex or portal. See {@link TwistInOutProps}.
|
|
2098
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2099
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2100
|
+
* @param props The properties of the effect
|
|
2101
|
+
* @param priority The priority of the effect
|
|
2102
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2103
|
+
*/
|
|
2104
|
+
function twistIn(alias: string, component?: TComponent, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2105
|
+
/**
|
|
2106
|
+
* Remove a image from the canvas with a twist effect: the image winds up into a swirl before being
|
|
2107
|
+
* removed. See {@link twistIn} and {@link TwistInOutProps}.
|
|
2108
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2109
|
+
* @param props The properties of the effect
|
|
2110
|
+
* @param priority The priority of the effect
|
|
2111
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2112
|
+
*/
|
|
2113
|
+
function twistOut(alias: string, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* Show a image in the canvas with a warp effect: the image arrives out of radial zoom-blur streaks,
|
|
2116
|
+
* like dropping out of hyperspace. See {@link WarpInOutProps}.
|
|
2117
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2118
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2119
|
+
* @param props The properties of the effect
|
|
2120
|
+
* @param priority The priority of the effect
|
|
2121
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2122
|
+
*/
|
|
2123
|
+
function warpIn(alias: string, component?: TComponent, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Remove a image from the canvas with a warp effect: the image streaks away in a radial zoom blur
|
|
2126
|
+
* before being removed. See {@link warpIn} and {@link WarpInOutProps}.
|
|
2127
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2128
|
+
* @param props The properties of the effect
|
|
2129
|
+
* @param priority The priority of the effect
|
|
2130
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2131
|
+
*/
|
|
2132
|
+
function warpOut(alias: string, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2133
|
+
/**
|
|
2134
|
+
* Show a image in the canvas with a ripple effect: the image fades in through a ring of water-like
|
|
2135
|
+
* distortion spreading outward from an origin point - for dreams, magic or memories. See
|
|
2136
|
+
* {@link RippleInOutProps}.
|
|
2137
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2138
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2139
|
+
* @param props The properties of the effect
|
|
2140
|
+
* @param priority The priority of the effect
|
|
2141
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2142
|
+
*/
|
|
2143
|
+
function rippleIn(alias: string, component?: TComponent, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2144
|
+
/**
|
|
2145
|
+
* Remove a image from the canvas with a ripple effect: a ring of water-like distortion spreads over
|
|
2146
|
+
* the image as it fades out and is removed. See {@link rippleIn} and {@link RippleInOutProps}.
|
|
2147
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2148
|
+
* @param props The properties of the effect
|
|
2149
|
+
* @param priority The priority of the effect
|
|
2150
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2151
|
+
*/
|
|
2152
|
+
function rippleOut(alias: string, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2153
|
+
/**
|
|
2154
|
+
* Show a image in the canvas with a noise dissolve: the image appears in organic, noise-shaped
|
|
2155
|
+
* blotches (or a cloudy fade with `edge: "soft"`) - the classic visual-novel image dissolve. See
|
|
2156
|
+
* {@link NoiseDissolveInOutProps}.
|
|
2157
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2158
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2159
|
+
* @param props The properties of the effect
|
|
2160
|
+
* @param priority The priority of the effect
|
|
2161
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2162
|
+
*/
|
|
2163
|
+
function noiseDissolveIn(alias: string, component?: TComponent, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2164
|
+
/**
|
|
2165
|
+
* Remove a image from the canvas with a noise dissolve: the image disappears in noise-shaped
|
|
2166
|
+
* blotches and is then removed. See {@link noiseDissolveIn} and {@link NoiseDissolveInOutProps}.
|
|
2167
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2168
|
+
* @param props The properties of the effect
|
|
2169
|
+
* @param priority The priority of the effect
|
|
2170
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2171
|
+
*/
|
|
2172
|
+
function noiseDissolveOut(alias: string, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2173
|
+
/**
|
|
2174
|
+
* Show a image in the canvas like an old TV turning on: a bright dot stretches into a glowing
|
|
2175
|
+
* horizontal line, which then opens up into the full image, with CRT scanlines. The scale animates
|
|
2176
|
+
* around the component's own anchor/pivot, so a centered anchor looks best. See
|
|
2177
|
+
* {@link TvInOutProps}.
|
|
2178
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2179
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2180
|
+
* @param props The properties of the effect
|
|
2181
|
+
* @param priority The priority of the effect
|
|
2182
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2183
|
+
*/
|
|
2184
|
+
function tvIn(alias: string, component?: TComponent, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2185
|
+
/**
|
|
2186
|
+
* Remove a image from the canvas like an old TV turning off: the image collapses into a glowing
|
|
2187
|
+
* horizontal line, then into a dot, and is removed. The scale animates around the component's own
|
|
2188
|
+
* anchor/pivot, so a centered anchor looks best. See {@link tvIn} and {@link TvInOutProps}.
|
|
2189
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2190
|
+
* @param props The properties of the effect
|
|
2191
|
+
* @param priority The priority of the effect
|
|
2192
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2193
|
+
*/
|
|
2194
|
+
function tvOut(alias: string, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2195
|
+
/**
|
|
2196
|
+
* Show a image in the canvas with a pinch effect: the image emerges from a single point, deforming
|
|
2197
|
+
* outward as it settles (or puffs out of it with `mode: "bulge"`). See {@link PinchInOutProps}.
|
|
2198
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2199
|
+
* @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
|
|
2200
|
+
* @param props The properties of the effect
|
|
2201
|
+
* @param priority The priority of the effect
|
|
2202
|
+
* @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
|
|
2203
|
+
*/
|
|
2204
|
+
function pinchIn(alias: string, component?: TComponent, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
|
|
2205
|
+
/**
|
|
2206
|
+
* Remove a image from the canvas with a pinch effect: the image is sucked into a single point (or
|
|
2207
|
+
* puffs out with `mode: "bulge"`) and removed. See {@link pinchIn} and {@link PinchInOutProps}.
|
|
2208
|
+
* @param alias The unique alias of the image. You can use this alias to refer to this image
|
|
2209
|
+
* @param props The properties of the effect
|
|
2210
|
+
* @param priority The priority of the effect
|
|
2211
|
+
* @returns The ids of the tickers that are used in the effect.
|
|
2212
|
+
*/
|
|
2213
|
+
function pinchOut(alias: string, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
|
|
2214
|
+
}
|
|
1818
2215
|
|
|
1819
2216
|
/**
|
|
1820
2217
|
* Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
|
|
@@ -1961,6 +2358,337 @@ interface ShakeEffectProps extends BaseTransitionProps, AnimationOptions {
|
|
|
1961
2358
|
*/
|
|
1962
2359
|
maxShockSize?: number;
|
|
1963
2360
|
}
|
|
2361
|
+
/**
|
|
2362
|
+
* Shared options for the generic, repeated articulated-animation effects ({@link BounceEffectProps},
|
|
2363
|
+
* {@link HopEffectProps}, {@link WiggleEffectProps}, {@link NodEffectProps}, {@link SwayEffectProps}):
|
|
2364
|
+
* a number of cycles, each one shrinking towards rest by {@link decay}.
|
|
2365
|
+
*/
|
|
2366
|
+
interface DecayingEffectProps extends BaseTransitionProps, AnimationOptions {
|
|
2367
|
+
/**
|
|
2368
|
+
* How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
|
|
2369
|
+
* amplitude, `0` = the second cycle onward has no amplitude at all).
|
|
2370
|
+
* @default 0.5
|
|
2371
|
+
*/
|
|
2372
|
+
decay?: number;
|
|
2373
|
+
}
|
|
2374
|
+
interface BounceEffectProps extends DecayingEffectProps {
|
|
2375
|
+
/**
|
|
2376
|
+
* The direction the component displaces towards on each bounce, before returning to rest.
|
|
2377
|
+
* @default "up"
|
|
2378
|
+
*/
|
|
2379
|
+
direction?: "up" | "down" | "left" | "right";
|
|
2380
|
+
/**
|
|
2381
|
+
* The distance (in pixels) of the first, largest bounce.
|
|
2382
|
+
* @default 30
|
|
2383
|
+
*/
|
|
2384
|
+
distance?: number;
|
|
2385
|
+
/**
|
|
2386
|
+
* The number of bounces.
|
|
2387
|
+
* @default 4
|
|
2388
|
+
*/
|
|
2389
|
+
bounces?: number;
|
|
2390
|
+
}
|
|
2391
|
+
interface PulseEffectProps extends DecayingEffectProps {
|
|
2392
|
+
/**
|
|
2393
|
+
* The peak scale multiplier of the first, largest pulse (relative to the component's current
|
|
2394
|
+
* scale) - e.g. `1.2` grows the component 20% bigger at the peak of the first pulse.
|
|
2395
|
+
* @default 1.2
|
|
2396
|
+
*/
|
|
2397
|
+
scale?: number;
|
|
2398
|
+
/**
|
|
2399
|
+
* The number of pulses.
|
|
2400
|
+
* @default 3
|
|
2401
|
+
*/
|
|
2402
|
+
pulses?: number;
|
|
2403
|
+
}
|
|
2404
|
+
interface HopEffectProps extends DecayingEffectProps {
|
|
2405
|
+
/**
|
|
2406
|
+
* The direction of the (primary and any secondary) hops.
|
|
2407
|
+
* @default "up"
|
|
2408
|
+
*/
|
|
2409
|
+
direction?: "up" | "down" | "left" | "right";
|
|
2410
|
+
/**
|
|
2411
|
+
* The distance (in pixels) of the primary hop.
|
|
2412
|
+
* @default 40
|
|
2413
|
+
*/
|
|
2414
|
+
distance?: number;
|
|
2415
|
+
/**
|
|
2416
|
+
* The number of smaller, decaying hops to play after the primary one (`0` = just the one hop).
|
|
2417
|
+
* @default 0
|
|
2418
|
+
*/
|
|
2419
|
+
secondaryHops?: number;
|
|
2420
|
+
}
|
|
2421
|
+
interface WiggleEffectProps extends DecayingEffectProps {
|
|
2422
|
+
/**
|
|
2423
|
+
* The peak rotation (in degrees) away from the component's current angle, on the first repetition.
|
|
2424
|
+
* @default 15
|
|
2425
|
+
*/
|
|
2426
|
+
angle?: number;
|
|
2427
|
+
/**
|
|
2428
|
+
* The number of repetitions.
|
|
2429
|
+
* @default 3
|
|
2430
|
+
*/
|
|
2431
|
+
repetitions?: number;
|
|
2432
|
+
}
|
|
2433
|
+
interface NodEffectProps extends DecayingEffectProps {
|
|
2434
|
+
/**
|
|
2435
|
+
* The axis the component oscillates along.
|
|
2436
|
+
* @default "horizontal"
|
|
2437
|
+
*/
|
|
2438
|
+
axis?: "horizontal" | "vertical";
|
|
2439
|
+
/**
|
|
2440
|
+
* The distance (in pixels) of the first, largest oscillation.
|
|
2441
|
+
* @default 15
|
|
2442
|
+
*/
|
|
2443
|
+
distance?: number;
|
|
2444
|
+
/**
|
|
2445
|
+
* The number of repetitions.
|
|
2446
|
+
* @default 3
|
|
2447
|
+
*/
|
|
2448
|
+
repetitions?: number;
|
|
2449
|
+
}
|
|
2450
|
+
interface SwayEffectProps extends DecayingEffectProps {
|
|
2451
|
+
/**
|
|
2452
|
+
* The distance (in pixels) of the positional drift, on the first repetition.
|
|
2453
|
+
* @default 10
|
|
2454
|
+
*/
|
|
2455
|
+
distance?: number;
|
|
2456
|
+
/**
|
|
2457
|
+
* The rotational drift (in degrees) away from the component's current angle, on the first
|
|
2458
|
+
* repetition.
|
|
2459
|
+
* @default 5
|
|
2460
|
+
*/
|
|
2461
|
+
angle?: number;
|
|
2462
|
+
/**
|
|
2463
|
+
* The axis the positional drift moves along.
|
|
2464
|
+
* @default "horizontal"
|
|
2465
|
+
*/
|
|
2466
|
+
axis?: "horizontal" | "vertical";
|
|
2467
|
+
/**
|
|
2468
|
+
* The number of repetitions.
|
|
2469
|
+
* @default 3
|
|
2470
|
+
*/
|
|
2471
|
+
repetitions?: number;
|
|
2472
|
+
}
|
|
2473
|
+
interface PunchEffectProps extends BaseTransitionProps, AnimationOptions {
|
|
2474
|
+
/**
|
|
2475
|
+
* Which property the punch animates.
|
|
2476
|
+
* @default "scale"
|
|
2477
|
+
*/
|
|
2478
|
+
mode?: "x" | "y" | "rotation" | "scale";
|
|
2479
|
+
/**
|
|
2480
|
+
* The strength of the punch's attack - a pixel distance for `x`/`y`, degrees for `rotation`, or a
|
|
2481
|
+
* scale multiplier delta for `scale` (e.g. `0.3` peaks at 1.3x the current scale).
|
|
2482
|
+
* @default 0.3
|
|
2483
|
+
*/
|
|
2484
|
+
strength?: number;
|
|
2485
|
+
/**
|
|
2486
|
+
* How far the recovery overshoots past rest, in the opposite direction, as a fraction of
|
|
2487
|
+
* {@link strength} (`0` = no overshoot, settles straight back to rest).
|
|
2488
|
+
* @default 0.3
|
|
2489
|
+
*/
|
|
2490
|
+
overshoot?: number;
|
|
2491
|
+
}
|
|
2492
|
+
interface GlitchEffectProps extends DecayingEffectProps {
|
|
2493
|
+
/**
|
|
2494
|
+
* The peak slice-displacement amount (pixels) of the first, largest burst.
|
|
2495
|
+
* @default 40
|
|
2496
|
+
*/
|
|
2497
|
+
strength?: number;
|
|
2498
|
+
/**
|
|
2499
|
+
* The number of glitch bursts.
|
|
2500
|
+
* @default 3
|
|
2501
|
+
*/
|
|
2502
|
+
bursts?: number;
|
|
2503
|
+
/**
|
|
2504
|
+
* The number of glitch slices.
|
|
2505
|
+
* @default 8
|
|
2506
|
+
*/
|
|
2507
|
+
slices?: number;
|
|
2508
|
+
/**
|
|
2509
|
+
* The angle (in degrees) slices are displaced along.
|
|
2510
|
+
* @default 0
|
|
2511
|
+
*/
|
|
2512
|
+
direction?: number;
|
|
2513
|
+
/**
|
|
2514
|
+
* The peak red/blue channel separation (pixels) layered on top of the slice displacement,
|
|
2515
|
+
* following the same jittery envelope. `0` disables it.
|
|
2516
|
+
* @default 6
|
|
2517
|
+
*/
|
|
2518
|
+
rgbSplit?: number;
|
|
2519
|
+
}
|
|
2520
|
+
interface ChromaticAberrationEffectProps extends DecayingEffectProps {
|
|
2521
|
+
/**
|
|
2522
|
+
* The peak red/blue channel pixel offset of the first, largest burst (channels split in opposite
|
|
2523
|
+
* directions, green stays centered).
|
|
2524
|
+
* @default 8
|
|
2525
|
+
*/
|
|
2526
|
+
strength?: number;
|
|
2527
|
+
/**
|
|
2528
|
+
* The axis the channels split along.
|
|
2529
|
+
* @default "horizontal"
|
|
2530
|
+
*/
|
|
2531
|
+
axis?: "horizontal" | "vertical";
|
|
2532
|
+
/**
|
|
2533
|
+
* The number of bursts.
|
|
2534
|
+
* @default 1
|
|
2535
|
+
*/
|
|
2536
|
+
bursts?: number;
|
|
2537
|
+
}
|
|
2538
|
+
interface ShockwaveEffectProps extends BaseTransitionProps, AnimationOptions {
|
|
2539
|
+
/**
|
|
2540
|
+
* The origin of the ripple, normalized (0-1) to the element's own bounds.
|
|
2541
|
+
* @default {x: 0.5, y: 0.5}
|
|
2542
|
+
*/
|
|
2543
|
+
origin?: {
|
|
2544
|
+
x: number;
|
|
2545
|
+
y: number;
|
|
2546
|
+
};
|
|
2547
|
+
/**
|
|
2548
|
+
* The amplitude of the ripple.
|
|
2549
|
+
* @default 30
|
|
2550
|
+
*/
|
|
2551
|
+
amplitude?: number;
|
|
2552
|
+
/**
|
|
2553
|
+
* The wavelength of the ripple.
|
|
2554
|
+
* @default 160
|
|
2555
|
+
*/
|
|
2556
|
+
wavelength?: number;
|
|
2557
|
+
/**
|
|
2558
|
+
* The brightness of the ripple.
|
|
2559
|
+
* @default 1
|
|
2560
|
+
*/
|
|
2561
|
+
brightness?: number;
|
|
2562
|
+
/**
|
|
2563
|
+
* The maximum radius (in pixels) the ripple travels before fading out. A value `<= 0` means the
|
|
2564
|
+
* ripple travels an infinite distance.
|
|
2565
|
+
* @default -1
|
|
2566
|
+
*/
|
|
2567
|
+
radius?: number;
|
|
2568
|
+
/**
|
|
2569
|
+
* The speed (in pixels-per-second) the ripple travels outward.
|
|
2570
|
+
* @default 500
|
|
2571
|
+
*/
|
|
2572
|
+
speed?: number;
|
|
2573
|
+
/**
|
|
2574
|
+
* How far the ripple's own internal "time" advances by the end of the animation (the ring's
|
|
2575
|
+
* radius is `time * speed` pixels). By default it's just enough for the ring to fully leave the
|
|
2576
|
+
* component - origin to farthest corner plus half a {@link wavelength} - or {@link radius} when set,
|
|
2577
|
+
* divided by {@link speed}.
|
|
2578
|
+
*/
|
|
2579
|
+
strength?: number;
|
|
2580
|
+
}
|
|
2581
|
+
interface RadialBlurEffectProps extends DecayingEffectProps {
|
|
2582
|
+
/**
|
|
2583
|
+
* The peak zoom-blur strength of the first, largest burst.
|
|
2584
|
+
* @default 0.5
|
|
2585
|
+
*/
|
|
2586
|
+
strength?: number;
|
|
2587
|
+
/**
|
|
2588
|
+
* The number of bursts.
|
|
2589
|
+
* @default 1
|
|
2590
|
+
*/
|
|
2591
|
+
bursts?: number;
|
|
2592
|
+
/**
|
|
2593
|
+
* The origin the blur radiates from, normalized (0-1) to the element's own bounds.
|
|
2594
|
+
* @default {x: 0.5, y: 0.5}
|
|
2595
|
+
*/
|
|
2596
|
+
origin?: {
|
|
2597
|
+
x: number;
|
|
2598
|
+
y: number;
|
|
2599
|
+
};
|
|
2600
|
+
/**
|
|
2601
|
+
* The inner radius (in pixels) excluded from the blur.
|
|
2602
|
+
* @default 0
|
|
2603
|
+
*/
|
|
2604
|
+
innerRadius?: number;
|
|
2605
|
+
/**
|
|
2606
|
+
* The outer radius (in pixels) of the blur. A value `< 0` means the blur extends infinitely.
|
|
2607
|
+
* @default -1
|
|
2608
|
+
*/
|
|
2609
|
+
radius?: number;
|
|
2610
|
+
}
|
|
2611
|
+
interface BlurPulseEffectProps extends DecayingEffectProps {
|
|
2612
|
+
/**
|
|
2613
|
+
* The peak blur strength of the first, largest pulse.
|
|
2614
|
+
* @default 8
|
|
2615
|
+
*/
|
|
2616
|
+
strength?: number;
|
|
2617
|
+
/**
|
|
2618
|
+
* The number of pulses.
|
|
2619
|
+
* @default 3
|
|
2620
|
+
*/
|
|
2621
|
+
pulses?: number;
|
|
2622
|
+
/**
|
|
2623
|
+
* The blur filter's own render quality (number of blur passes). Higher looks smoother but costs
|
|
2624
|
+
* more to render.
|
|
2625
|
+
* @default 4
|
|
2626
|
+
*/
|
|
2627
|
+
quality?: number;
|
|
2628
|
+
}
|
|
2629
|
+
interface VignettePulseEffectProps extends DecayingEffectProps {
|
|
2630
|
+
/**
|
|
2631
|
+
* The peak vignette opacity of the first, largest pulse.
|
|
2632
|
+
* @default 1
|
|
2633
|
+
*/
|
|
2634
|
+
strength?: number;
|
|
2635
|
+
/**
|
|
2636
|
+
* The number of pulses.
|
|
2637
|
+
* @default 1
|
|
2638
|
+
*/
|
|
2639
|
+
pulses?: number;
|
|
2640
|
+
/**
|
|
2641
|
+
* How far the darkening reaches in from the corners, from `0` (none) to `1` (the whole element) -
|
|
2642
|
+
* `0.5` darkens roughly the outer half.
|
|
2643
|
+
* @default 0.5
|
|
2644
|
+
*/
|
|
2645
|
+
radius?: number;
|
|
2646
|
+
/**
|
|
2647
|
+
* How soft the transition from the clear center to the dark edges is (`0` = a hard edge).
|
|
2648
|
+
* @default 0.5
|
|
2649
|
+
*/
|
|
2650
|
+
blur?: number;
|
|
2651
|
+
}
|
|
2652
|
+
interface DesaturateEffectProps extends BaseTransitionProps, AnimationOptions {
|
|
2653
|
+
/**
|
|
2654
|
+
* The saturation floor reached at the trough (`0` = full grayscale, `1` = no desaturation at all).
|
|
2655
|
+
* @default 0
|
|
2656
|
+
*/
|
|
2657
|
+
amount?: number;
|
|
2658
|
+
/**
|
|
2659
|
+
* How long the component stays at {@link amount} before recovering back to normal saturation, on
|
|
2660
|
+
* top of the fade in/out (each {@link AnimationOptions.duration}).
|
|
2661
|
+
* @default 0
|
|
2662
|
+
*/
|
|
2663
|
+
holdDuration?: number;
|
|
2664
|
+
}
|
|
2665
|
+
interface GlowPulseEffectProps extends DecayingEffectProps {
|
|
2666
|
+
/**
|
|
2667
|
+
* The peak outward glow strength of the first, largest pulse.
|
|
2668
|
+
* @default 4
|
|
2669
|
+
*/
|
|
2670
|
+
strength?: number;
|
|
2671
|
+
/**
|
|
2672
|
+
* The number of pulses.
|
|
2673
|
+
* @default 3
|
|
2674
|
+
*/
|
|
2675
|
+
pulses?: number;
|
|
2676
|
+
/**
|
|
2677
|
+
* The color of the glow.
|
|
2678
|
+
* @default 0xffffff
|
|
2679
|
+
*/
|
|
2680
|
+
color?: number;
|
|
2681
|
+
/**
|
|
2682
|
+
* The distance (in pixels) the glow extends.
|
|
2683
|
+
* @default 10
|
|
2684
|
+
*/
|
|
2685
|
+
distance?: number;
|
|
2686
|
+
/**
|
|
2687
|
+
* The strength of the glow inward from the edge of the component.
|
|
2688
|
+
* @default 0
|
|
2689
|
+
*/
|
|
2690
|
+
innerStrength?: number;
|
|
2691
|
+
}
|
|
1964
2692
|
|
|
1965
2693
|
/**
|
|
1966
2694
|
* An empty interface that can be augmented via `declare module '@drincs/pixi-vn/canvas'`
|
|
@@ -2045,4 +2773,4 @@ declare const UPDATE_PRIORITY: typeof _drincs_pixi_vn_pixi_js.UPDATE_PRIORITY;
|
|
|
2045
2773
|
|
|
2046
2774
|
declare const canvas: CanvasManagerInterface;
|
|
2047
2775
|
|
|
2048
|
-
export { AdditionalPositionsExtension, AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetAliasIdType, type AssetMemory, Assets, type BundleIdType, type CanvasBaseInterface, CanvasBaseItem, CanvasBaseItemMemory, CanvasGameState, type CanvasHtmlLayersInterface, type CanvasLayersInterface, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, type
|
|
2776
|
+
export { AdditionalPositionsExtension, AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetAliasIdType, type AssetMemory, Assets, type BlurInOutProps, type BlurPulseEffectProps, type BounceEffectProps, type BundleIdType, type CanvasBaseInterface, CanvasBaseItem, CanvasBaseItemMemory, CanvasGameState, type CanvasHtmlLayersInterface, type CanvasLayersInterface, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, type ChromaticAberrationEffectProps, Color, type ColorType, Container, ContainerChild$1 as ContainerChild, ContainerMemory, type ContainerOptions, type DecayingEffectProps, type DesaturateEffectProps, type FilterFadeTransitionProps, type FlashInOutProps, type GlitchEffectProps, type GlitchInOutProps, type GlowPulseEffectProps, type HopEffectProps, type HslColorType, type HslaColorType, type HsvColorType, type HsvaColorType, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type IrisInOutProps, type Layer, ListenerExtension, ListenerExtensionMemory, type MaskTransitionProps, type MoveInOutProps, type NodEffectProps, type NoiseDissolveInOutProps, OnEventsHandlers, type PinchInOutProps, type PixelateInOutProps, type PixivnAssetAliasIds, type PixivnBundleIds, type PulseEffectProps, type PunchEffectProps, type PushInOutProps, type RadialBlurEffectProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, type RgbColorType, type RgbaColorType, type RippleInOutProps, type ShakeEffectProps, type ShockwaveEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, type SplitInOutProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, type SwayEffectProps, Text, type TextMemory, type TextOptions, TextStyle, Texture, type TvInOutProps, type TwistInOutProps, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type VignettePulseEffectProps, type WarpInOutProps, type WiggleEffectProps, type WipeInOutProps, type ZoomInOutProps, addImage, addImageCointainer, addVideo, canvas, canvasComponentDecorator, drawCanvasErrorHandler, effects, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, transitions, zoomIn, zoomOut };
|