@drincs/pixi-vn 1.8.16 → 1.8.18

package/dist/canvas.d.cts

@@ -203,7 +203,7 @@ interface TickerTimeoutHistory {
 
 type CommonTickerProps = {
     /**
-     * The alias to remove after the effect is done
+     * An array of strings containing the aliases of the canvas components to remove after the animation completes.
      * @default []
      */
     aliasToRemoveAfter?: string[] | string;
@@ -213,12 +213,12 @@ type CommonTickerProps = {
      */
     startOnlyIfHaveTexture?: boolean;
     /**
-     * The alias to resume after the effect is done
+     * If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.
      * @default []
      */
     tickerAliasToResume?: string[] | string;
     /**
-     * The id of the ticker to resume after the effect is done
+     * A string containing the ticker ID to resume after the animation completes.
      * @default []
      */
     tickerIdToResume?: string[] | string;
@@ -227,6 +227,7 @@ type CommonTickerProps = {
      */
     forceCompleteBeforeNext?: boolean;
     /**
+     * A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
      * When true, calling {@link narration.continue()} forces the current content to complete before advancing to the next narrative step.
      * @default false
      */
@@ -326,8 +327,8 @@ interface CanvasManagerInterface {
      * Add a canvas element to the canvas.
      * If there is a canvas element with the same alias, all "style", zIndex, and {@link TickerBase} will be transferred to the new canvas element,
      * and the old canvas element will be removed.
-     * @param alias The alias of the canvas element.
-     * @param canvasComponent The canvas elements to be added.
+     * @param alias The alias to identify the component.
+     * @param canvasComponent The component to add.
      * @param options The options of the canvas element.
      * @example
      * ```ts
@@ -368,8 +369,8 @@ interface CanvasManagerInterface {
     }): void;
     /**
      * Get a canvas element by the alias.
-     * @param alias The alias of the canvas element.
-     * @returns The canvas element.
+     * @param alias The alias to identify the component.
+     * @returns The canvas element. If the component does not exist, it will return `undefined`.
      * @example
      * ```ts
      * const sprite = canvas.find<Sprite>("bunny");
@@ -388,8 +389,8 @@ interface CanvasManagerInterface {
     removeAll(): void;
     /**
      * Edit the alias of a canvas element. The tickers that are connected to the canvas element will be transferred.
-     * @param oldAlias The old alias of the canvas element.
-     * @param newAlias The new alias of the canvas element.
+     * @param oldAlias The old alias of the component to edit.
+     * @param newAlias The new alias of the component.
      * @param options The options of the canvas element.
      */
     editAlias(oldAlias: string, newAlias: string, options?: {
@@ -552,12 +553,12 @@ interface CanvasManagerInterface {
      *
      * Pixi’VN will keep track of the animation state of this function.
      * So Pixi’VN will save the animation state in saves.
-     * @param components - The PixiJS component(s) to animate.
-     * @param keyframes - The keyframes to animate the component(s) with.
-     * @param options - Additional options for the animation, including duration, easing, and ticker.
-     * @param priority - The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
-     * @returns The id of tickers.
-     * @template T - The type of Pixi’VN component(s) being animated.
+     * @param components The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.
+     * @param keyframes This is an object containing the properties to animate and the values to reach.
+     * @param options [`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.
+     * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority. @default UPDATE_PRIORITY.NORMAL
+     * @returns The function returns the ID of the ticker created to animate the component(s).
+     * @template T The type of Pixi’VN component(s) being animated.
      */
     animate<T extends CanvasBaseInterface<any>>(components: T | string | (string | T)[], keyframes: KeyframesType<T>, options?: AnimationOptions, priority?: UPDATE_PRIORITY$1): string | undefined;
     /**
@@ -566,12 +567,12 @@ interface CanvasManagerInterface {
      *
      * Pixi’VN will keep track of the animation state of this function.
      * So Pixi’VN will save the animation state in saves.
-     * @param components - The PixiJS component(s) to animate.
-     * @param sequence - The sequence of keyframes to animate the component(s) with.
-     * @param options - Additional options for the animation, including duration, easing, and ticker.
-     * @param priority - The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
-     * @returns The id of tickers.
-     * @template T - The type of Pixi’VN component(s) being animated.
+     * @param components The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.
+     * @param sequence The sequence of keyframes to animate the component(s) with.
+     * @param options [`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.
+     * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority. @default UPDATE_PRIORITY.NORMAL
+     * @returns The function returns the ID of the ticker created to animate the component(s).
+     * @template T The type of Pixi’VN component(s) being animated.
      */
     animate<T extends CanvasBaseInterface<any>>(components: T | string, sequence: (ObjectSegment<T> | ObjectSegmentWithTransition<T>)[], options?: SequenceOptions, priority?: UPDATE_PRIORITY$1): string | undefined;
     /**
@@ -746,6 +747,9 @@ interface SpriteMemory extends SpriteBaseMemory {
  * ```
  */
 declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = SpriteMemory> extends _drincs_pixi_vn_pixi_js__default.Sprite implements CanvasBaseItem<Memory | SpriteMemory>, ListenerExtension, AdditionalPositionsExtension {
+    /**
+     * @param options The options for the component.
+     */
     constructor(options?: SpriteOptions | Texture$1);
     readonly pixivnId: string;
     get memory(): Memory | SpriteMemory;
@@ -836,6 +840,10 @@ declare class ImageSprite<Memory extends ImageSpriteMemory = ImageSpriteMemory>
     private _textureAlias?;
     protected get textureAlias(): string;
     readonly pixivnId: string;
+    /**
+     * @param options The options for the component.
+     * @param textureAlias The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: ImageSpriteOptions | Omit<Texture$1, "on"> | undefined, textureAlias?: string);
     get memory(): ImageSpriteMemory;
     setMemory(memory: Memory | SpriteMemory): Promise<void>;
@@ -887,6 +895,10 @@ interface VideoSpriteMemory extends ImageSpriteMemory {
  * ```
  */
 declare class VideoSprite extends ImageSprite<VideoSpriteMemory> {
+    /**
+     * @param options The options for the component.
+     * @param textureAlias The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: VideoSpriteOptions | Texture$1 | undefined, textureAlias?: string);
     readonly pixivnId: string;
     get memory(): VideoSpriteMemory;
@@ -1031,6 +1043,10 @@ interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
  * ```
  */
 declare class ImageContainer extends Container<ImageSprite, ImageContainerMemory> {
+    /**
+     * @param options The options for the component.
+     * @param textureAliases An array of image URLs or paths. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: ImageContainerOptions<ImageSprite>, textureAliases?: string[]);
     get memory(): ImageContainerMemory;
     setMemory(value: ImageContainerMemory): Promise<void>;
@@ -1208,10 +1224,27 @@ type CanvasElementAliasType = string;
  * Is a decorator that register a canvas component in the game.
  * @param options Options for the canvas component.
  * @returns
+ * @example
+ * ```ts title="canvas/components/AlienTinting.ts"
+ * const ALIEN_TINTING_TEST_ID = "AlienTintingTest";
+ * @canvasComponentDecorator({
+ *     name: ALIEN_TINTING_TEST_ID,
+ * })
+ * class AlienTintingTest extends Sprite<IAlienTintingMemory> {
+ *     readonly pixivnId: string = CANVAS_SPINE_ID;
+ *     override get memory() {
+ *         // ...
+ *     }
+ *     override async setMemory(memory: IAlienTintingMemory) {
+ *         // ...
+ *     }
+ *     // ...
+ * }
+ * ```
  */
 declare function canvasComponentDecorator<M extends CanvasBaseItemMemory, T extends typeof CanvasBaseItem<M>>(options?: {
     /**
-     * Name of the canvas component. If the name is already registered, it will show a warning
+     * The id used by Pixi’VN to refer to this class (must be unique). If you don't pass the id, the class name will be used as the id.
      * @default target.name
      */
     name?: CanvasElementAliasType;
@@ -1307,7 +1340,7 @@ type SerializableEventHandler = (...args: never[]) => unknown;
  *
  * sprite.on("pointerdown", Events.eventExample);
  * ```
- * @param name is th identifier of the event, by default is the name of the class
+ * @param name The id used by Pixi’VN to refer to this function (must be unique). If you don't pass the id, the function name will be used as the id.
  * @returns
  */
 declare function eventDecorator(name?: string): (_target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
@@ -1345,9 +1378,9 @@ declare namespace RegisteredEvents {
 /**
  * Shake the canvas element.
  * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
- * @param alias
- * @param options
- * @param priority
+ * @param alias The alias to identify the component.
+ * @param options Animation options, matching the `options` of animate function.
+ * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
  * @returns
  */
 declare function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
@@ -1552,11 +1585,11 @@ declare function drawCanvasErrorHandler(): OnErrorHandler;
 /**
  * Add a list of images in the container, after that, the images are added to the canvas.
  * Is the same that {@link showImageContainer}, but the image is not shown.
- * If you want to show the image, then you need to use the function {@link ImageSprite.load()}.
- * @param alias is the unique alias of the image. You can use this alias to refer to this image
+ * If you want to show the container, then you need to use the function {@link ImageSprite.load()}.
+ * @param alias is the unique alias of the container. You can use this alias to refer to this container
  * @param imageUrls is the url of the image. If you don't provide the url, then the alias is used as the url.
- * @param options The options of the image.
- * @returns the container of the image.
+ * @param options The options of the container.
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
  * @example
  * ```ts
  * let bunny = addImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
@@ -1566,10 +1599,10 @@ declare function drawCanvasErrorHandler(): OnErrorHandler;
 declare function addImageCointainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): ImageContainer;
 /**
  * Add a list of images in the container, after that, the images are added and shown in the canvas.
- * @param alias The unique alias of the image. You can use this alias to refer to this image
+ * @param alias The unique alias of the container. You can use this alias to refer to this container
  * @param imageUrls The url of the image.
- * @param options The options of the image.
- * @returns A promise that is resolved when the image is loaded.
+ * @param options The options of the container.
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
  * @example
  * ```ts
  * let bunny = showImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
@@ -1582,9 +1615,9 @@ declare function showImageContainer(alias: string, imageUrls: string[], options?
  * Is the same that {@link showImage}, but the image is not shown.
  * If you want to show the image, then you need to use the function {@link ImageSprite.load}.
  * @param alias is the unique alias of the image. You can use this alias to refer to this image
- * @param imageUrl is the url of the image. If you don't provide the url, then the alias is used as the url.
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
  * @param options The options of the image.
- * @returns the container of the image.
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1599,9 +1632,9 @@ declare function addImage(alias: string, imageUrl?: string, options?: ImageSprit
 /**
  * Add and show a image in the canvas. This function is a combination of {@link addImage}.
  * @param alias The unique alias of the image. You can use this alias to refer to this image
- * @param imageUrl The url of the image.
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
  * @param options The options of the image.
- * @returns A promise that is resolved when the image is loaded.
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1617,7 +1650,7 @@ declare function showImage(alias: string, imageUrl?: string, options?: ImageSpri
  * @param alias The unique alias of the text. You can use this alias to refer to this text.
  * @param text
  * @param options The options of the text.
- * @returns A promise that is resolved when the text is loaded.
+ * @returns This function returns an {@link Text} that you can use to manipulate the component.
  * @example
  * ```ts
  * let text = showText("text", "Hello World", { fontSize: 24, fill: "white" })
@@ -1640,7 +1673,7 @@ declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefine
  * @param alias is the unique alias of the video. You can use this alias to refer to this video
  * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the video.
- * @returns the container of the video.
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1657,7 +1690,7 @@ declare function addVideo(alias: string, videoUrl?: string, options?: VideoSprit
  * @param alias The unique alias of the video. You can use this alias to refer to this video
  * @param videoUrl The url of the video.
  * @param options The options of the video.
- * @returns A promise that is resolved when the video is loaded.
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts

package/dist/canvas.d.ts

@@ -203,7 +203,7 @@ interface TickerTimeoutHistory {
 
 type CommonTickerProps = {
     /**
-     * The alias to remove after the effect is done
+     * An array of strings containing the aliases of the canvas components to remove after the animation completes.
      * @default []
      */
     aliasToRemoveAfter?: string[] | string;
@@ -213,12 +213,12 @@ type CommonTickerProps = {
      */
     startOnlyIfHaveTexture?: boolean;
     /**
-     * The alias to resume after the effect is done
+     * If you want to resume tickers that were previously paused, provide the aliases of the canvas components whose tickers should be resumed.
      * @default []
      */
     tickerAliasToResume?: string[] | string;
     /**
-     * The id of the ticker to resume after the effect is done
+     * A string containing the ticker ID to resume after the animation completes.
      * @default []
      */
     tickerIdToResume?: string[] | string;
@@ -227,6 +227,7 @@ type CommonTickerProps = {
      */
     forceCompleteBeforeNext?: boolean;
     /**
+     * A boolean indicating whether the animation must complete before the next `step` of the game. If `true`, the game will force the animation to finish before proceeding.
      * When true, calling {@link narration.continue()} forces the current content to complete before advancing to the next narrative step.
      * @default false
      */
@@ -326,8 +327,8 @@ interface CanvasManagerInterface {
      * Add a canvas element to the canvas.
      * If there is a canvas element with the same alias, all "style", zIndex, and {@link TickerBase} will be transferred to the new canvas element,
      * and the old canvas element will be removed.
-     * @param alias The alias of the canvas element.
-     * @param canvasComponent The canvas elements to be added.
+     * @param alias The alias to identify the component.
+     * @param canvasComponent The component to add.
      * @param options The options of the canvas element.
      * @example
      * ```ts
@@ -368,8 +369,8 @@ interface CanvasManagerInterface {
     }): void;
     /**
      * Get a canvas element by the alias.
-     * @param alias The alias of the canvas element.
-     * @returns The canvas element.
+     * @param alias The alias to identify the component.
+     * @returns The canvas element. If the component does not exist, it will return `undefined`.
      * @example
      * ```ts
      * const sprite = canvas.find<Sprite>("bunny");
@@ -388,8 +389,8 @@ interface CanvasManagerInterface {
     removeAll(): void;
     /**
      * Edit the alias of a canvas element. The tickers that are connected to the canvas element will be transferred.
-     * @param oldAlias The old alias of the canvas element.
-     * @param newAlias The new alias of the canvas element.
+     * @param oldAlias The old alias of the component to edit.
+     * @param newAlias The new alias of the component.
      * @param options The options of the canvas element.
      */
     editAlias(oldAlias: string, newAlias: string, options?: {
@@ -552,12 +553,12 @@ interface CanvasManagerInterface {
      *
      * Pixi’VN will keep track of the animation state of this function.
      * So Pixi’VN will save the animation state in saves.
-     * @param components - The PixiJS component(s) to animate.
-     * @param keyframes - The keyframes to animate the component(s) with.
-     * @param options - Additional options for the animation, including duration, easing, and ticker.
-     * @param priority - The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
-     * @returns The id of tickers.
-     * @template T - The type of Pixi’VN component(s) being animated.
+     * @param components The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.
+     * @param keyframes This is an object containing the properties to animate and the values to reach.
+     * @param options [`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.
+     * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority. @default UPDATE_PRIORITY.NORMAL
+     * @returns The function returns the ID of the ticker created to animate the component(s).
+     * @template T The type of Pixi’VN component(s) being animated.
      */
     animate<T extends CanvasBaseInterface<any>>(components: T | string | (string | T)[], keyframes: KeyframesType<T>, options?: AnimationOptions, priority?: UPDATE_PRIORITY$1): string | undefined;
     /**
@@ -566,12 +567,12 @@ interface CanvasManagerInterface {
      *
      * Pixi’VN will keep track of the animation state of this function.
      * So Pixi’VN will save the animation state in saves.
-     * @param components - The PixiJS component(s) to animate.
-     * @param sequence - The sequence of keyframes to animate the component(s) with.
-     * @param options - Additional options for the animation, including duration, easing, and ticker.
-     * @param priority - The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
-     * @returns The id of tickers.
-     * @template T - The type of Pixi’VN component(s) being animated.
+     * @param components The PixiJS component(s) to animate. This can be a single component, an array of components, or a string representing the component's alias.
+     * @param sequence The sequence of keyframes to animate the component(s) with.
+     * @param options [`motion` options](https://motion.dev/docs/animate#options) for the animation, including duration, `easing`, and ticker.
+     * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority. @default UPDATE_PRIORITY.NORMAL
+     * @returns The function returns the ID of the ticker created to animate the component(s).
+     * @template T The type of Pixi’VN component(s) being animated.
      */
     animate<T extends CanvasBaseInterface<any>>(components: T | string, sequence: (ObjectSegment<T> | ObjectSegmentWithTransition<T>)[], options?: SequenceOptions, priority?: UPDATE_PRIORITY$1): string | undefined;
     /**
@@ -746,6 +747,9 @@ interface SpriteMemory extends SpriteBaseMemory {
  * ```
  */
 declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = SpriteMemory> extends _drincs_pixi_vn_pixi_js__default.Sprite implements CanvasBaseItem<Memory | SpriteMemory>, ListenerExtension, AdditionalPositionsExtension {
+    /**
+     * @param options The options for the component.
+     */
     constructor(options?: SpriteOptions | Texture$1);
     readonly pixivnId: string;
     get memory(): Memory | SpriteMemory;
@@ -836,6 +840,10 @@ declare class ImageSprite<Memory extends ImageSpriteMemory = ImageSpriteMemory>
     private _textureAlias?;
     protected get textureAlias(): string;
     readonly pixivnId: string;
+    /**
+     * @param options The options for the component.
+     * @param textureAlias The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: ImageSpriteOptions | Omit<Texture$1, "on"> | undefined, textureAlias?: string);
     get memory(): ImageSpriteMemory;
     setMemory(memory: Memory | SpriteMemory): Promise<void>;
@@ -887,6 +895,10 @@ interface VideoSpriteMemory extends ImageSpriteMemory {
  * ```
  */
 declare class VideoSprite extends ImageSprite<VideoSpriteMemory> {
+    /**
+     * @param options The options for the component.
+     * @param textureAlias The URL or path. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: VideoSpriteOptions | Texture$1 | undefined, textureAlias?: string);
     readonly pixivnId: string;
     get memory(): VideoSpriteMemory;
@@ -1031,6 +1043,10 @@ interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
  * ```
  */
 declare class ImageContainer extends Container<ImageSprite, ImageContainerMemory> {
+    /**
+     * @param options The options for the component.
+     * @param textureAliases An array of image URLs or paths. If you have initialized the "asset matrix", you can use the alias of the texture.
+     */
     constructor(options?: ImageContainerOptions<ImageSprite>, textureAliases?: string[]);
     get memory(): ImageContainerMemory;
     setMemory(value: ImageContainerMemory): Promise<void>;
@@ -1208,10 +1224,27 @@ type CanvasElementAliasType = string;
  * Is a decorator that register a canvas component in the game.
  * @param options Options for the canvas component.
  * @returns
+ * @example
+ * ```ts title="canvas/components/AlienTinting.ts"
+ * const ALIEN_TINTING_TEST_ID = "AlienTintingTest";
+ * @canvasComponentDecorator({
+ *     name: ALIEN_TINTING_TEST_ID,
+ * })
+ * class AlienTintingTest extends Sprite<IAlienTintingMemory> {
+ *     readonly pixivnId: string = CANVAS_SPINE_ID;
+ *     override get memory() {
+ *         // ...
+ *     }
+ *     override async setMemory(memory: IAlienTintingMemory) {
+ *         // ...
+ *     }
+ *     // ...
+ * }
+ * ```
  */
 declare function canvasComponentDecorator<M extends CanvasBaseItemMemory, T extends typeof CanvasBaseItem<M>>(options?: {
     /**
-     * Name of the canvas component. If the name is already registered, it will show a warning
+     * The id used by Pixi’VN to refer to this class (must be unique). If you don't pass the id, the class name will be used as the id.
      * @default target.name
      */
     name?: CanvasElementAliasType;
@@ -1307,7 +1340,7 @@ type SerializableEventHandler = (...args: never[]) => unknown;
  *
  * sprite.on("pointerdown", Events.eventExample);
  * ```
- * @param name is th identifier of the event, by default is the name of the class
+ * @param name The id used by Pixi’VN to refer to this function (must be unique). If you don't pass the id, the function name will be used as the id.
  * @returns
  */
 declare function eventDecorator(name?: string): (_target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
@@ -1345,9 +1378,9 @@ declare namespace RegisteredEvents {
 /**
  * Shake the canvas element.
  * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
- * @param alias
- * @param options
- * @param priority
+ * @param alias The alias to identify the component.
+ * @param options Animation options, matching the `options` of animate function.
+ * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
  * @returns
  */
 declare function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
@@ -1552,11 +1585,11 @@ declare function drawCanvasErrorHandler(): OnErrorHandler;
 /**
  * Add a list of images in the container, after that, the images are added to the canvas.
  * Is the same that {@link showImageContainer}, but the image is not shown.
- * If you want to show the image, then you need to use the function {@link ImageSprite.load()}.
- * @param alias is the unique alias of the image. You can use this alias to refer to this image
+ * If you want to show the container, then you need to use the function {@link ImageSprite.load()}.
+ * @param alias is the unique alias of the container. You can use this alias to refer to this container
  * @param imageUrls is the url of the image. If you don't provide the url, then the alias is used as the url.
- * @param options The options of the image.
- * @returns the container of the image.
+ * @param options The options of the container.
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
  * @example
  * ```ts
  * let bunny = addImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
@@ -1566,10 +1599,10 @@ declare function drawCanvasErrorHandler(): OnErrorHandler;
 declare function addImageCointainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): ImageContainer;
 /**
  * Add a list of images in the container, after that, the images are added and shown in the canvas.
- * @param alias The unique alias of the image. You can use this alias to refer to this image
+ * @param alias The unique alias of the container. You can use this alias to refer to this container
  * @param imageUrls The url of the image.
- * @param options The options of the image.
- * @returns A promise that is resolved when the image is loaded.
+ * @param options The options of the container.
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
  * @example
  * ```ts
  * let bunny = showImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
@@ -1582,9 +1615,9 @@ declare function showImageContainer(alias: string, imageUrls: string[], options?
  * Is the same that {@link showImage}, but the image is not shown.
  * If you want to show the image, then you need to use the function {@link ImageSprite.load}.
  * @param alias is the unique alias of the image. You can use this alias to refer to this image
- * @param imageUrl is the url of the image. If you don't provide the url, then the alias is used as the url.
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
  * @param options The options of the image.
- * @returns the container of the image.
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1599,9 +1632,9 @@ declare function addImage(alias: string, imageUrl?: string, options?: ImageSprit
 /**
  * Add and show a image in the canvas. This function is a combination of {@link addImage}.
  * @param alias The unique alias of the image. You can use this alias to refer to this image
- * @param imageUrl The url of the image.
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
  * @param options The options of the image.
- * @returns A promise that is resolved when the image is loaded.
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1617,7 +1650,7 @@ declare function showImage(alias: string, imageUrl?: string, options?: ImageSpri
  * @param alias The unique alias of the text. You can use this alias to refer to this text.
  * @param text
  * @param options The options of the text.
- * @returns A promise that is resolved when the text is loaded.
+ * @returns This function returns an {@link Text} that you can use to manipulate the component.
  * @example
  * ```ts
  * let text = showText("text", "Hello World", { fontSize: 24, fill: "white" })
@@ -1640,7 +1673,7 @@ declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefine
  * @param alias is the unique alias of the video. You can use this alias to refer to this video
  * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the video.
- * @returns the container of the video.
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts
@@ -1657,7 +1690,7 @@ declare function addVideo(alias: string, videoUrl?: string, options?: VideoSprit
  * @param alias The unique alias of the video. You can use this alias to refer to this video
  * @param videoUrl The url of the video.
  * @param options The options of the video.
- * @returns A promise that is resolved when the video is loaded.
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
  * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```ts