@drincs/pixi-vn 0.6.0 → 0.6.1

package/dist/functions/ImageUtility.d.mts

@@ -1,6 +1,8 @@
 import { UPDATE_PRIORITY } from 'pixi.js';
 import CanvasBase from '../classes/canvas/CanvasBase.mjs';
 import CanvasImage from '../classes/canvas/CanvasImage.mjs';
+import { FadeAlphaTickerProps } from '../types/ticker/FadeAlphaTickerProps.mjs';
+import { tagToRemoveAfterType } from '../types/ticker/TagToRemoveAfterType.mjs';
 import '../interface/canvas/ICanvasBaseMemory.mjs';
 import '../interface/canvas/ICanvasImageMemory.mjs';
 import '../interface/canvas/ICanvasSpriteMemory.mjs';
@@ -29,7 +31,14 @@ declare function addImage(tag: string, imageUrl: string): CanvasImage;
  * @param canvasImages is a list of images to show.
  * @returns the list of images.
  */
-declare function loadImages(canvasImages: CanvasImage[] | CanvasImage): Promise<CanvasImage[]>;
+declare function loadImage(canvasImages: CanvasImage[] | CanvasImage): Promise<CanvasImage[]>;
+/**
+ * Add and show a image in the canvas. This function is a combination of {@link addImage} and {@link loadImage}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param imageUrl The url of the image.
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showImage(tag: string, imageUrl: string): Promise<CanvasImage>;
 /**
  * Remove a image from the canvas.
  * @param tag is the unique tag of the image. You can use this tag to refer to this image
@@ -38,14 +47,45 @@ declare function removeCanvasElement(tag: string | string[]): void;
 /**
  * Show a image in the canvas with a disolve effect.
  * Disolve effect is a effect that the image is shown with a fade in.
- * If exist a image with the same tag, then the image is replaced. And the first image is removed after the effect is done.
+ * If exist a image with the same tag, then the image is replaced and the first image is removed after the effect is done.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param image The imageUrl or the canvas element
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showWithDissolveTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): Promise<void>;
+/**
+ * Remove a image from the canvas with a disolve effect.
+ * Disolve effect is a effect that the image is removed with a fade out.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * This function is equivalent to {@link removeWithFadeTransition}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ */
+declare function removeWithDissolveTransition(tag: string | string[], props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): void;
+/**
+ * Show a image in the canvas with a fade effect.
+ * Fade effect is a effect that the image is shown with a fade in.
+ * If exist a image with the same tag, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
  * @param tag The unique tag of the image. You can use this tag to refer to this image
  * @param image The imageUrl or the canvas element
- * @param args The arguments of the effect
- * @param duration The duration of the effect
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showWithFadeTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): Promise<void>;
+/**
+ * Remove a image from the canvas with a fade effect.
+ * Fade effect is a effect that the image is removed with a fade out.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * This function is equivalent to {@link removeWithDissolveTransition}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param props The properties of the effect
  * @param priority The priority of the effect
- * @returns The sprite of the image.
  */
-declare function showWithDissolveTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, speed: number, priority?: UPDATE_PRIORITY): Promise<void>;
+declare function removeWithFadeTransition(tag: string | string[], props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): void;
 
-export { addImage, loadImages, removeCanvasElement, showWithDissolveTransition };
+export { addImage, loadImage, removeCanvasElement, removeWithDissolveTransition, removeWithFadeTransition, showImage, showWithDissolveTransition, showWithFadeTransition };

package/dist/functions/ImageUtility.d.ts

@@ -1,6 +1,8 @@
 import { UPDATE_PRIORITY } from 'pixi.js';
 import CanvasBase from '../classes/canvas/CanvasBase.js';
 import CanvasImage from '../classes/canvas/CanvasImage.js';
+import { FadeAlphaTickerProps } from '../types/ticker/FadeAlphaTickerProps.js';
+import { tagToRemoveAfterType } from '../types/ticker/TagToRemoveAfterType.js';
 import '../interface/canvas/ICanvasBaseMemory.js';
 import '../interface/canvas/ICanvasImageMemory.js';
 import '../interface/canvas/ICanvasSpriteMemory.js';
@@ -29,7 +31,14 @@ declare function addImage(tag: string, imageUrl: string): CanvasImage;
  * @param canvasImages is a list of images to show.
  * @returns the list of images.
  */
-declare function loadImages(canvasImages: CanvasImage[] | CanvasImage): Promise<CanvasImage[]>;
+declare function loadImage(canvasImages: CanvasImage[] | CanvasImage): Promise<CanvasImage[]>;
+/**
+ * Add and show a image in the canvas. This function is a combination of {@link addImage} and {@link loadImage}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param imageUrl The url of the image.
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showImage(tag: string, imageUrl: string): Promise<CanvasImage>;
 /**
  * Remove a image from the canvas.
  * @param tag is the unique tag of the image. You can use this tag to refer to this image
@@ -38,14 +47,45 @@ declare function removeCanvasElement(tag: string | string[]): void;
 /**
  * Show a image in the canvas with a disolve effect.
  * Disolve effect is a effect that the image is shown with a fade in.
- * If exist a image with the same tag, then the image is replaced. And the first image is removed after the effect is done.
+ * If exist a image with the same tag, then the image is replaced and the first image is removed after the effect is done.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param image The imageUrl or the canvas element
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showWithDissolveTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): Promise<void>;
+/**
+ * Remove a image from the canvas with a disolve effect.
+ * Disolve effect is a effect that the image is removed with a fade out.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * This function is equivalent to {@link removeWithFadeTransition}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ */
+declare function removeWithDissolveTransition(tag: string | string[], props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): void;
+/**
+ * Show a image in the canvas with a fade effect.
+ * Fade effect is a effect that the image is shown with a fade in.
+ * If exist a image with the same tag, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
  * @param tag The unique tag of the image. You can use this tag to refer to this image
  * @param image The imageUrl or the canvas element
- * @param args The arguments of the effect
- * @param duration The duration of the effect
+ * @param props The properties of the effect
+ * @param priority The priority of the effect
+ * @returns A promise that is resolved when the image is loaded.
+ */
+declare function showWithFadeTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): Promise<void>;
+/**
+ * Remove a image from the canvas with a fade effect.
+ * Fade effect is a effect that the image is removed with a fade out.
+ * This transition is done with a {@link FadeAlphaTicker} effect.
+ * This function is equivalent to {@link removeWithDissolveTransition}.
+ * @param tag The unique tag of the image. You can use this tag to refer to this image
+ * @param props The properties of the effect
  * @param priority The priority of the effect
- * @returns The sprite of the image.
  */
-declare function showWithDissolveTransition<T extends CanvasBase<any> | string = string>(tag: string, image: T, speed: number, priority?: UPDATE_PRIORITY): Promise<void>;
+declare function removeWithFadeTransition(tag: string | string[], props?: Omit<FadeAlphaTickerProps, "type" | tagToRemoveAfterType | "startOnlyIfHaveTexture">, priority?: UPDATE_PRIORITY): void;
 
-export { addImage, loadImages, removeCanvasElement, showWithDissolveTransition };
+export { addImage, loadImage, removeCanvasElement, removeWithDissolveTransition, removeWithFadeTransition, showImage, showWithDissolveTransition, showWithFadeTransition };